工具参考

Lovrabet MCP 提供以下工具，AI 编辑器会根据你的需求自动调用。

数据集探索工具

list_datasets - 列出数据集

获取应用下所有数据集的列表。

参数：

参数	必填	说明
`appCode`	否	应用代码，默认使用环境变量 `LOVRABET_APP_CODE`
`cookie`	否	Cookie 字符串
`env`	否	环境：`online`（默认）或 `daily`，默认使用环境变量 `LOVRABETET_ENV`
`pageSize`	否	每页数量，默认 999
`currentPage`	否	当前页码，默认 1
`forceRefresh`	否	是否强制刷新缓存，默认 false

返回信息：

数据集 ID、名称、代码
表名、数据源
是否为虚拟数据集
分页信息

search_datasets - 搜索数据集

通过关键词搜索数据集（搜索范围：名称、表名、代码、描述）。

参数：

参数	必填	说明
`appCode`	否	应用代码，默认使用环境变量
`cookie`	否	Cookie 字符串
`env`	否	环境：`online`（默认）或 `daily`
`keyword`	是	搜索关键词

返回信息：

搜索结果列表

get_dataset_detail - 获取数据集详情

获取指定数据集的完整信息，包括所有字段定义、操作列表、SQL 验证辅助信息等。

参数：

参数	必填	说明
`appCode`	否	应用代码，默认使用环境变量
`cookie`	否	Cookie 字符串串
`env`	否	环境：`online`（默认）或 `daily`
`datasetCode`	是	数据集代码或 ID（支持代码字符串或数字 ID）
`forceRefresh`	否	是否强制刷新缓存，默认 false

返回信息：

basic - 基本信息：名称、代码、表名、数据源等
fields - 字段列表（包含必填、主键、枚举值、数据库类型等完整元数据）
operations - 操作列表：支持的 API 操作
stats - 统计信息：字段数、操作数、是否支持 CRUD
sqlValidationHints - SQL 验证辅助信息：
- primaryKeys - 主键字段列表
- filterableFields - 常用于 WHERE 条件的字段
- joinableFields - 可用于 JOIN 的关联字段
- requiredFields - 必填字段列表
- enumFields - 枚举字段及其选项
nextSteps - 建议的下一步操作

get_dataset_operations - 获取操作列表

获取数据集支持的所有 API 操作。

参数：

参数	必填	说明
`appCode`	否	应用代码，默认使用环境变量
`cookie`	否	Cookie 字符串串
`env`	否	环境：`online`（默认）或 `daily`
`datasetCode`	是	数据集代码或 ID

返回信息：

datasetName - 数据集名称
tableName - 表名
operations - 操作列表：
- name - 操作名称
- displayName - 显示名称
- type - 操作类型
- method - HTTP 方法
- path - API 路径
- requestFieldsCount - 请求字段数量
- enabled - 是否启用
stats - 统计信息：
- total - 总操作数
- enabled - 已启用操作数
- supportsCRUD - 是否支持 CRUD

get_operation_detail - 获取操作详情

获取指定操作的详细信息，包括请求字段、返回值格式、SDK 调用说明。

参数：

参数	必填	说明
`appCode`	否	应用代码，默认使用环境变量
`cookie`	否	Cookie 字符串串
`env`	否	环境：`online`（默认）或 `daily`
`datasetCode`	是	数据集代码或 ID
`operationName`	是	操作名称（如 `filter`、`create`、`update`）

返回信息：

datasetName - 数据集名称
operation - 操作完整信息
sdkReturnValueBehavior - SDK 返回值行为说明：
- onSuccess - 成功时返回的数据格式说明
- onError - 失败时抛出的异常说明
- note - 重要提示

代码生成工具

generate_sdk_code - 生成 SDK 代码

为指定操作生成完整的 TypeScript SDK 调用代码，包含完整的错误处理和类型定义。

参数：

参数	必填	说明
`appCode`	否	应用代码，默认使用环境变量
`cookie`	否	Cookie 字符串串
`env`	否	环境：`online`（默认）或 `daily`
`datasetCode`	是	数据集代码或 ID
`operationName`	是	操作名称
`includeImports`	否	是否包含导入语句，默认 true
`useAlias`	否	是否使用别名模式（默认 false）
		- `false` - 使用 `dataset_[完整code]` 模式（推荐，稳定）
		- `true` - 使用 camelCase 别名模式（需要 SDK >= 1.2.0）

返回信息：

code - 生成的 SDK 代码（已包含数据集和数据表注释）
fields - 字段元数据（必填、枚举值等）
sdkReturnValueBehavior - SDK 返回值行为说明
aliasHint - 别名使用提示（包含版本要求说明）
nextSteps - 建议的下一步操作

generate_sql_code - 生成 SQL 代码

为自定义 SQL 查询生成 TypeScript SDK 调用代码。

参数：

参数	必填	说明
`appCode`	否	应用代码，默认使用环境变量
`cookie`	否	Cookie 字符串串
`env`	否	环境：`online`（默认）或 `daily`
`sqlCode`	是	SQL 代码（从 `list_sql_queries` 的 `sqlCode` 字段获取）
`params`	否	SQL 参数对象
`includeImports`	否	是否包含导入语句，默认 true

返回信息：

code - 生成的 TypeScript 代码
sqlName - SQL 名称
sqlExists - SQL 是否存在
parameters - 参数列表
usage - 使用说明

SQL 管理工具

list_sql_queries - 列出 SQL 查询

列出应用中所有可用的自定义 SQL 查询，包含完整的调用示例和参数说明。

参数：

参数	必填	说明
`appCode`	否	应用代码，默认使用环境变量
`cookie`	否	Cookie 字符串串
`env`	否	环境：`online`（默认）或 `daily`
`keyword`	否	按名称或描述搜索
`category`	否	按分类筛选
`sqlCode`	否	按 SQL 代码模糊匹配
`sqlName`	否	按 SQL 名称模糊匹配
`pageSize`	否	每页数量，默认 999
`currentPage`	否	当前页码，默认 1

返回信息：

sqls - SQL 查询列表，每个包含：
- sqlCode - SQL 代码标识符
- sqlId - SQL ID
- name - SQL 名称
- description - SQL 描述
- category - SQL 分类
- sqlContent - SQL 语句内容
- parameters - 参数列表及示例值
- codeExample - 完整的 TypeScript 调用代码
pagination - 分页信息
usage - 使用说明和重要提示

save_or_update_custom_sql - 保存或更新自定义 SQL

保存或更新用户自定义的 SQL 查询（仅允许 SELECT 语句，支持 MyBatis 语法）。

参数：

参数	必填	说明
`appCode`	否	应用代码，默认使用环境变量
`cookie`	否	Cookie 字符串串
`env`	否	环境：`online`（默认）或 `daily`
`sqlName`	是	SQL 名称
`dbId`	是	数据库 ID
`sqlContent`	是	SQL 内容（仅 SELECT，支持 MyBatis 语法）
`sqlCode`	否	SQL 代码（更新时需要）
`id`	否	SQL ID（更新时需要）
`verifyAfterSave`	否	保存后自动验证，默认 true
`validateSchema`	否	是否验证模式，默认 false

返回信息：

action - 操作类型：created 或 updated
message - 操作结果消息
data - 保存的数据
parsedStructure - 解析的 SQL 结构（表、列、参数）
verified - 验证结果（如果 verifyAfterSave=true）
nextSteps - 建议的下一步操作

execute_custom_sql - 执行自定义 SQL

执行自定义 SQL 查询并返回结果，包含智能的错误处理和修复建议。

参数：

参数	必填	说明
`appCode`	否	应用代码，默认使用环境变量
`cookie`	否	Cookie 字符串串
`env`	否	环境：`online`（默认）或 `daily`
`sqlCode`	是	SQL 代码（从 `list_sql_queries` 获取）
`params`	否	SQL 参数对象

返回信息：

success - API 调用是否成功（HTTP 层面）
execSuccess - SQL 执行是否成功（业务逻辑层面）
execResult - 查询结果（成功时）
execError - 错误信息（失败时）
rowCount - 返回行数
message - 人类可读的消息
executionTime - 执行时间（毫秒）
errorCode - 错误代码
fixSuggestions - 错误修复建议
nextSteps - 建议的下一步操作
sqlInfo - SQL 信息（用于参考）

validate_sql_content - 验证 SQL 内容

在保存 SQL 之前验证其语法和结构。

参数：

参数	必填	说明
`appCode`	否	应用代码，默认使用环境变量
`cookie`	否	Cookie 字符串串
`env`	否	环境：`online`（默认）或 `daily`
`sqlContent`	是	要验证的 SQL 内容
`dbId`	否	数据库 ID（用于模式验证）
`validateSchemas`	否	要验证的数据集代码列表

返回信息：

success - 验证是否成功
message - 验证结果消息
validation - 验证结果详情：
- valid - 是否通过验证
- errors - 错误列表
- warnings - 警告列表
nextSteps - 建议的下一步操作

认证工具

参数：

参数	必填	说明
`env`	否	环境：`online`（默认）或 `daily`

返回信息：

success - 是否成功
message - 结果消息
loginUrl - 登录链接
**env` - 使用的环境

使用方式：

请帮我登录 Lovrabet

参数说明

环境变量

环境变量	必填	默认值	说明
`LOVRABET_APP_CODE`	是	-	你的 Lovrabet 应用 AppCode
`LOVRABET_ENV`	否	`online`	环境：`online` 或 `daily`
`LOVRABET_BASE_URL`	否	官方地址	自定义 API 地址
`LOVRABET_AUTH_COOKIE`	否	-	直接传入 Cookie 字符串（跳过登录）
`MCP_DEBUG`	否	-	设置为 `1` 启用详细日志

datasetCode 参数说明

datasetCode 参数支持两种格式：

格式	说明	示例
代码字符串	数据集代码	`customer`, `order`, `product`
数字 ID	数据集数字 ID	`1000372`, `1000373`

返回值规范

SDK 返回值行为

成功时：直接返回 data 字段的内容
失败时：抛出 LovrabetError 异常

// ✅ 成功：直接返回 data
const result = await client.models.customer.create({ name: "张三" });
console.log(result.id); // 直接访问数据

// ❌ 失败：抛出异常
try {
  const result = await client.models.customer.create({ name: "" });
} catch (error) {
  if (error instanceof Lovrabet) {
    console.error("错误:", error.message);
  }
}

SQL 返回值结构

SQL 查询的返回值结构：

{
  execSuccess: boolean;  // SQL 执行是否成功
  execResult?: any[];   // 查询结果
  execError?: string;   // 错误信息
}

重要：必须检查 execSuccess 才能使用 execResult！

快速参考

常用工具组合流程

探索数据集 → 生成代码：

步骤1：使用 list_datasets 或 search_datasets 找到目标数据集
步骤2：使用 get_dataset_detail 获取完整字段信息
步骤3：使用 generate_sdk_code 生成 SDK 代码

SQL 开发完整流程：

步骤1：使用 list_sql_queries 查询现有 SQL
步骤2：使用 validate_sql_content 验证 SQL 语法
步骤3：使用 save_or_update_custom_sql 保存 SQL
步骤4：使用 execute_custom_sql 测试执行

获取帮助

📖 使用场景与 Prompt 示例 - 常见业务场景的对话示例
📖 SDK 返回值说明 - SDK 调用注意事项
💬 GitHub Issues

数据集探索工具​

list_datasets - 列出数据集​

search_datasets - 搜索数据集​

get_dataset_detail - 获取数据集详情​

get_dataset_operations - 获取操作列表​

get_operation_detail - 获取操作详情​

代码生成工具​

generate_sdk_code - 生成 SDK 代码​

generate_sql_code - 生成 SQL 代码​

SQL 管理工具​

list_sql_queries - 列出 SQL 查询​

save_or_update_custom_sql - 保存或更新自定义 SQL​

execute_custom_sql - 执行自定义 SQL​

validate_sql_content - 验证 SQL 内容​

认证工具​

login - 登录认证​

参数说明​

环境变量​

datasetCode 参数说明​

返回值规范​

SDK 返回值行为​

SQL 返回值结构​

快速参考​

常用工具组合流程​

获取帮助​

数据集探索工具

list_datasets - 列出数据集

search_datasets - 搜索数据集

get_dataset_detail - 获取数据集详情

get_dataset_operations - 获取操作列表

get_operation_detail - 获取操作详情

代码生成工具

generate_sdk_code - 生成 SDK 代码

generate_sql_code - 生成 SQL 代码

SQL 管理工具

list_sql_queries - 列出 SQL 查询

save_or_update_custom_sql - 保存或更新自定义 SQL

execute_custom_sql - 执行自定义 SQL

validate_sql_content - 验证 SQL 内容

认证工具

login - 登录认证

参数说明

环境变量

datasetCode 参数说明

返回值规范

SDK 返回值行为

SQL 返回值结构

快速参考

常用工具组合流程

获取帮助