Tool Reference

Lovrabet MCP provides the following tools, which AI editors will automatically call based on your needs.

---

Dataset Exploration Tools

list_datasets - List Datasets

Get a list of all datasets under the application.

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to environment variable LOVRABET_APP_CODE
cookie	No	Cookie string
env	No	Environment: online (default) or daily, defaults to environment variable LOVRABET_ENV
pageSize	No	Number per page, default 999
currentPage	No	Current page number, default 1
forceRefresh	No	Force refresh cache, default false

Returned Information:

• Dataset ID, name, code
• Table name, data source
• Whether it's a virtual dataset
• Pagination information

---

search_datasets - Search Datasets

Search datasets by keyword (search scope: name, table name, code, description).

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to environment variable
cookie	No	Cookie string
env	No	Environment: online (default) or daily
keyword	Yes	Search keyword

Returned Information:

• Search result list

---

get_dataset_detail - Get Dataset Detail

Get complete information for a specified dataset, including all field definitions, operation list, SQL validation hints, etc.

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to environment variable
cookie	No	Cookie string
env	No	Environment: online (default) or daily
datasetCode	Yes	Dataset code or ID (supports code string or numeric ID)
forceRefresh	No	Force refresh cache, default false

Returned Information:

• basic - Basic information: name, code, table name, data source, etc.
• fields - Field list (including complete metadata like required, primary key, enum values, database types)
• operations - Operation list: supported API operations
• stats - Statistics: field count, operation count, CRUD support
• sqlValidationHints - SQL validation helper information:
  • primaryKeys - Primary key field list
  • filterableFields - Fields commonly used in WHERE conditions
  • joinableFields - Related fields available for JOIN
  • requiredFields - Required field list
  • enumFields - Enum fields and their options
• nextSteps - Suggested next steps

---

get_dataset_operations - Get Operations List

Get all API operations supported by the dataset.

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to environment variable
cookie	No	Cookie string
env	No	Environment: online (default) or daily
datasetCode	Yes	Dataset code or ID

Returned Information:

• datasetName - Dataset name
• tableName - Table name
• operations - Operation list:
  • name - Operation name
  • displayName - Display name
  • type - Operation type
  • method - HTTP method
  • path - API path
  • requestFieldsCount - Request field count
  • enabled - Whether enabled
• stats - Statistics:
  • total - Total operation count
  • enabled - Enabled operation count
  • supportsCRUD - Whether CRUD is supported

---

get_operation_detail - Get Operation Detail

Get detailed information for a specified operation, including request fields, return value format, SDK call instructions.

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to environment variable
cookie	No	Cookie string
env	No	Environment: online (default) or daily
datasetCode	Yes	Dataset code or ID
operationName	Yes	Operation name (e.g., filter, create, update)

Returned Information:

• datasetName - Dataset name
• operation - Complete operation information
• sdkReturnValueBehavior - SDK return value behavior description:
  • onSuccess - Data format description on success
  • onError - Exception description on failure
  • note - Important notes

---

Code Generation Tools

generate_sdk_code - Generate SDK Code

Generate complete TypeScript SDK call code for a specified operation, including complete error handling and type definitions.

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to environment variable
cookie	No	Cookie string
env	No	Environment: online (default) or daily
datasetCode	Yes	Dataset code or ID
operationName	Yes	Operation name
includeImports	No	Whether to include import statements, default true
useAlias	No	Whether to use alias mode (default false)
		- false - Use dataset_[full code] mode (recommended, stable)
		- true - Use camelCase alias mode (requires SDK >= 1.2.0)

Returned Information:

• code - Generated SDK code (includes dataset and table comments)
• fields - Field metadata (required, enum values, etc.)
• sdkReturnValueBehavior - SDK return value behavior description
• aliasHint - Alias usage hint (includes version requirements)
• nextSteps - Suggested next steps

---

generate_sql_code - Generate SQL Code

Generate TypeScript SDK call code for custom SQL queries.

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to environment variable
cookie	No	Cookie string
env	No	Environment: online (default) or daily
sqlCode	Yes	SQL code (obtained from sqlCode field of list_sql_queries)
params	No	SQL parameter object
includeImports	No	Whether to include import statements, default true

Returned Information:

• code - Generated TypeScript code
• sqlName - SQL name
• sqlExists - Whether SQL exists
• parameters - Parameter list
• usage - Usage instructions

---

SQL Management Tools

list_sql_queries - List SQL Queries

List all available custom SQL queries in the application, including complete call examples and parameter descriptions.

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to environment variable
cookie	No	Cookie string
env	No	Environment: online (default) or daily
keyword	No	Search by name or description
category	No	Filter by category
sqlCode	No	Fuzzy match by SQL code
sqlName	No	Fuzzy match by SQL name
pageSize	No	Number per page, default 999
currentPage	No	Current page number, default 1

Returned Information:

• sqls - SQL query list, each containing:
  • sqlCode - SQL code identifier
  • sqlId - SQL ID
  • name - SQL name
  • description - SQL description
  • category - SQL category
  • sqlContent - SQL statement content
  • parameters - Parameter list with example values
  • codeExample - Complete TypeScript call code
• pagination - Pagination information
• usage - Usage instructions and important notes

---

save_or_update_custom_sql - Save or Update Custom SQL

Save or update user-defined SQL queries (only SELECT statements allowed, MyBatis syntax supported).

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to environment variable
cookie	No	Cookie string
env	No	Environment: online (default) or daily
sqlName	Yes	SQL name
dbId	Yes	Database ID
sqlContent	Yes	SQL content (SELECT only, MyBatis syntax supported)
sqlCode	No	SQL code (required when updating)
id	No	SQL ID (required when updating)
verifyAfterSave	No	Auto-validate after save, default true
validateSchema	No	Whether to validate schema, default false

Returned Information:

• action - Action type: created or updated
• message - Operation result message
• data - Saved data
• parsedStructure - Parsed SQL structure (tables, columns, parameters)
• verified - Validation result (if verifyAfterSave=true)
• nextSteps - Suggested next steps

---

execute_custom_sql - Execute Custom SQL

Execute custom SQL queries and return results with intelligent error handling and fix suggestions.

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to environment variable
cookie	No	Cookie string
env	No	Environment: online (default) or daily
sqlCode	Yes	SQL code (obtained from list_sql_queries)
params	No	SQL parameter object

Returned Information:

• success - Whether API call succeeded (HTTP level)
• execSuccess - Whether SQL execution succeeded (business logic level)
• execResult - Query result (on success)
• execError - Error message (on failure)
• rowCount - Number of rows returned
• message - Human-readable message
• executionTime - Execution time (milliseconds)
• errorCode - Error code
• fixSuggestions - Error fix suggestions
• nextSteps - Suggested next steps
• sqlInfo - SQL information (for reference)

---

validate_sql_content - Validate SQL Content

Validate SQL syntax and structure before saving.

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to environment variable
cookie	No	Cookie string
env	No	Environment: online (default) or daily
sqlContent	Yes	SQL content to validate
dbId	No	Database ID (for schema validation)
validateSchemas	No	Dataset code list to validate

Returned Information:

• success - Whether validation succeeded
• message - Validation result message
• validation - Validation result details:
  • valid - Whether passed validation
  • errors - Error list
  • warnings - Warning list
• nextSteps - Suggested next steps

---

Backend Function Tools

Feature Note

Backend Function (BFF) tools require the MCP server to be started with --dangerously-bff-save flag to enable save functionality. List and query features are available by default.

list_bff_scripts - List Backend Function Scripts

List all available Backend Function scripts in the application.

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to environment variable
cookie	No	Cookie string
env	No	Environment: online (default) or daily

Returned Information:

• scripts - Script list, each containing:
  • scriptName - Script name
  • description - Script description
  • createdAt - Creation time
  • updatedAt - Update time
  • status - Script status

---

get_bff_script_info - Get Script Details

Get detailed information for a specified Backend Function script, including code content and parameter descriptions.

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to environment variable
cookie	No	Cookie string
env	No	Environment: online (default) or daily
scriptName	Yes	Script name

Returned Information:

• scriptName - Script name
• description - Script description
• code - Script code
• params - Parameter descriptions
• usage - Usage examples

---

save_or_update_bff_script - Save or Update Script

Save or update Backend Function script code.

Note

This feature requires the MCP server to be started with --dangerously-bff-save flag.

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to environment variable
cookie	No	Cookie string
env	No	Environment: online (default) or daily
scriptName	Yes	Script name
code	Yes	Script code (JavaScript/TypeScript)
description	No	Script description

Returned Information:

• action - Action type: created or updated
• message - Operation result message
• scriptName - Script name

---

Authentication Tools

login - Login Authentication

Log in to Lovrabet platform to obtain access permissions.

Parameters:

No parameters required. The login tool automatically uses configuration from environment variables (LOVRABET_ENV).

Returned Information:

• success - Whether successful
• message - Result message
• loginUrl - Login URL
• env - Environment used

Usage: Simply tell the AI you need to log in:

Please help me log in to Lovrabet

Login Flow:

1. Tool checks if already logged in, returns success if so
2. Starts a local secure server
3. Returns login URL, you need to complete login in browser
4. Automatically saves credentials locally after successful login

Environment Configuration: To switch environment, set environment variable in MCP configuration:

{
  "env": {
    "LOVRABET_ENV": "daily"  // or "online"
  }
}

---

Parameter Reference

Environment Variables

Environment Variable	Required	Default	Description
LOVRABET_APP_CODE	Yes	-	Your Lovrabet application AppCode
LOVRABET_ENV	No	online	Environment: online or daily
LOVRABET_BASE_URL	No	Official URL	Custom API address
LOVRABET_AUTH_COOKIE	No	-	Directly pass Cookie string (skip login)
MCP_DEBUG	No	-	Set to 1 to enable verbose logging

datasetCode Parameter Reference

The datasetCode parameter supports two formats:

Format	Description	Example
Code string	Dataset code	customer, order, product
Numeric ID	Dataset numeric ID	1000372, 1000373

---

Return Value Specifications

SDK Return Value Behavior

• On success: Directly return contents of data field
• On failure: Throw LovrabetError exception

// Success: directly return data
const result = await client.models.customer.create({ name: "Zhang San" });
console.log(result.id); // Direct access to data

// Failure: throws exception
try {
  const result = await client.models.customer.create({ name: "" });
} catch (error) {
  if (error instanceof Lovrabet) {
    console.error("Error:", error.message);
  }
}

SQL Return Value Structure

SQL query return value structure:

{
  execSuccess: boolean;  // Whether SQL execution succeeded
  execResult?: any[];   // Query result
  execError?: string;   // Error message
}

Important: Must check execSuccess before using execResult!

---

Quick Reference

Common Tool Combination Workflows

Explore Dataset -> Generate Code:

Step 1: Use list_datasets or search_datasets to find target dataset
Step 2: Use get_dataset_detail to get complete field information
Step 3: Use generate_sdk_code to generate SDK code

SQL Development Complete Workflow:

Step 1: Use list_sql_queries to query existing SQL
Step 2: Use validate_sql_content to validate SQL syntax
Step 3: Use save_or_update_custom_sql to save SQL
Step 4: Use execute_custom_sql to test execution

---

Get Help

• Use Cases & Prompt Examples - Conversation examples for common business scenarios
• SDK Return Value Guide - SDK call considerations
• GitHub Issues