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 env var LOVRABET_APP_CODE
cookie	No	Cookie string
env	No	Environment: online (default) or daily, defaults to env var 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 info

---

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 env var
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 Details

Get complete information of a specified dataset, including all field definitions, operation list, SQL validation hints, and more.

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to env var
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 info: name, code, table name, data source
• fields - Field list (including required, primary key, enum values, database type, etc.)
• operations - Operation list: supported API operations
• stats - Statistics: field count, operation count, CRUD support
• sqlValidationHints - SQL validation helpers:
  • primaryKeys - Primary key fields
  • filterableFields - Fields commonly used in WHERE clauses
  • joinableFields - Fields available for JOIN operations
  • 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 env var
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 Details

Get detailed information of a specified operation, including request fields, return value format, SDK calling description.

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to env var
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 info
• sdkReturnValueBehavior - SDK return value behavior:
  • onSuccess - Return format on success
  • onError - Exception description on failure
  • note - Important notes

---

Code Generation Tools

generate_sdk_code - Generate SDK Code

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

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to env var
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_[fullcode] 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 calling code for custom SQL queries.

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to env var
cookie	No	Cookie string
env	No	Environment: online (default) or daily
sqlCode	Yes	SQL code (get sqlCode from list_sql_queries)
params	No	SQL parameters 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 calling examples and parameter descriptions.

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to env var
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 includes:
  • sqlCode - SQL code identifier
  • sqlId - SQL ID
  • name - SQL name
  • description - SQL description
  • category - SQL category
  • sqlContent - SQL statement
  • parameters - Parameter list with example values
  • codeExample - Complete TypeScript calling code
• pagination - Pagination info
• usage - Usage instructions and important notes

---

save_or_update_custom_sql - Save or Update Custom SQL

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

Parameters:

Parameter	Required	Description
appCode	No	Application code, defaults to env var
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 for updates)
id	No	SQL ID (required for updates)
verifyAfterSave	No	Auto-validate after save, default true
validateSchema	No	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 - Verification 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 env var
cookie	No	Cookie string
env	No	Environment: online (default) or daily
sqlCode	Yes	SQL code (get from list_sql_queries)
params	No	SQL parameters object

Returned Information:

• success - Whether API call succeeded (HTTP level)
• execSuccess - Whether SQL execution succeeded (business logic level)
• execResult - Query results (on success)
• execError - Error message (on failure)
• rowCount - Number of rows returned
• message - Human-readable message
• executionTime - Execution time in ms
• errorCode - Error code
• fixSuggestions - Error fix suggestions
• nextSteps - Suggested next steps
• sqlInfo - SQL info (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 env var
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

---

Authentication Tool

login - Login Authentication

Login to Lovrabet platform to obtain access permissions.

Parameters:

Parameter	Required	Description
env	No	Environment: online (default) or daily

Returned Information:

• success - Whether successful
• message - Result message
• **loginUrl` - Login link
• **env` - Environment used

Usage:

Please help me login to Lovrabet

---

Parameters Description

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	-	Direct Cookie string to bypass login
MCP_DEBUG	No	-	Set to 1 to enable verbose logging

datasetCode Parameter Description

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 Conventions

SDK Return Value Behavior

• Success: Returns only the data field content
• Failure: Throws LovrabetError exception

// ✅ Success: Returns data directly
const result = await client.models.customer.create({ name: "John" });
console.log(result.id); // Direct access

// ❌ 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;  // SQL execution success status
  execResult?: any[];   // Query results
  execError?: string;   // Error message
}

Important: Always check execSuccess before using execResult！

---

Quick Reference

Common Tool Combinations

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 - Prompt examples for common business scenarios
• 📖 SDK Return Value Guide - SDK calling notes
• 💬 GitHub Issues