Tool Reference
Currently includes 37 tools.
Source data: tools.json
Tool Overview
| Name | Description |
|---|---|
login | Login to CloudBase environment. **MUST** call this tool first before generating any CloudBase-related functionality. Login to CloudBase environment and select the environment to use. |
logout | Logout from CloudBase environment |
envQuery | Query CloudBase environment related information, supports querying environment list, current environment information, security domains and static website hosting configuration. (Original tool names: listEnvs/getEnvInfo/getEnvAuthDomains/getWebsiteConfig, these names can still be used for compatibility with old AI rules) |
envDomainManagement | Manage CloudBase environment security domains, supports add and delete operations. (Original tool names: createEnvDomain/deleteEnvDomain, these names can still be used for compatibility with old AI rules) |
readNoSqlDatabaseStructure | Read NoSQL database structure |
writeNoSqlDatabaseStructure | Modify NoSQL database structure |
readNoSqlDatabaseContent | Query and get NoSQL database data records |
writeNoSqlDatabaseContent | Modify NoSQL database data records |
executeReadOnlySQL | Execute a read-only SQL query on the SQL database. Note: For per-user ACL, each table should contain a fixed `_openid` column defined as `_openid VARCHAR(64) DEFAULT '' NOT NULL` that represents the user and is used for access control. |
executeWriteSQL | Execute a write SQL statement on the SQL database (INSERT, UPDATE, DELETE, etc.). Whenever you create a new table, you **must** include a fixed `_openid` column defined as `_openid VARCHAR(64) DEFAULT '' NOT NULL` that represents the user and is used for access control. |
manageDataModel | Data model query tool, supports querying and listing data models (read-only operations). list operation returns basic information (without Schema), get operation returns detailed information (with simplified Schema, including field list, format, relationships, etc.), docs operation generates SDK usage documentation |
modifyDataModel | Create or update data model based on Mermaid classDiagram. Supports creating new models and updating existing model structures. Built-in async task monitoring, automatically polls until completion or timeout. |
getFunctionList | Get cloud function list or single function details, distinguish operation type through action parameter |
createFunction | Create cloud function |
updateFunctionCode | Update existing function code. Note: This tool is only for updating code, does not support modifying function configuration (such as runtime). If you need to modify runtime, delete the function and use createFunction to recreate. |
updateFunctionConfig | Update cloud function configuration |
invokeFunction | Invoke cloud function |
getFunctionLogs | Get cloud function log basic information (LogList), if log details are needed, use RequestId to call getFunctionLogDetail tool. This interface is based on manager-node 4.4.0+ getFunctionLogsV2 implementation, does not return specific log content. Parameter offset+limit must not exceed 10000, startTime/endTime interval must not exceed one day. |
getFunctionLogDetail | Query log details based on RequestId returned by getFunctionLogs. Parameters startTime, endTime, requestId, returns log content (LogJson, etc.). Only supports manager-node 4.4.0+. |
manageFunctionTriggers | Create or delete cloud function triggers, distinguish operation type through action parameter |
uploadFiles | Upload files to static website hosting |
deleteFiles | Delete static website hosting files or folders |
findFiles | Search static website hosting files |
domainManagement | Unified domain management tool, supports binding, unbinding, querying and modifying domain configuration |
queryStorage | Query cloud storage information, supports listing directory files, getting file information, getting temporary download links and other read-only operations. Returned file information includes file name, size, modification time, download link, etc. |
manageStorage | Manage cloud storage files, supports uploading files/directories, downloading files/directories, deleting files/directories and other operations. Delete operation requires setting force=true for confirmation to prevent accidental deletion of important files. |
downloadTemplate | Automatically download and deploy CloudBase project templates. ⚠️ **MANDATORY FOR NEW PROJECTS** ⚠️ **CRITICAL**: This tool MUST be called FIRST when starting a new project. Supported templates: - react: React + CloudBase full-stack application template - vue: Vue + CloudBase full-stack application template - miniprogram: WeChat Mini Program + CloudBase template - uniapp: UniApp + CloudBase cross-platform application template - rules: Only includes AI editor configuration files (includes all mainstream editor configurations such as Cursor, WindSurf, CodeBuddy, etc.), suitable for supplementing AI editor configuration in existing projects Supported IDE types: - all: Download all IDE configurations (default) - cursor: Cursor AI editor - windsurf: WindSurf AI editor - codebuddy: CodeBuddy AI editor - claude-code: Claude Code AI editor - cline: Cline AI editor - gemini-cli: Gemini CLI - opencode: OpenCode AI editor - qwen-code: Tongyi Lingma - baidu-comate: Baidu Comate - openai-codex-cli: OpenAI Codex CLI - augment-code: Augment Code - github-copilot: GitHub Copilot - roocode: RooCode AI editor - tongyi-lingma: Tongyi Lingma - trae: Trae AI editor - vscode: Visual Studio Code Special notes: - rules template will automatically include current mcp version information (version: 2.1.0) for subsequent maintenance and version tracking - When downloading rules template, if README.md file already exists in the project, the system will automatically protect the file from being overwritten (unless overwrite=true is set) |
interactiveDialog | Unified interactive dialog tool, supports requirement clarification and task confirmation. When you need to confirm the next operation with the user, you can call the clarify of this tool. If there are sensitive operations that require user confirmation, you can call the confirm of this tool |
searchWeb | Use internet connection for information retrieval, such as querying latest news, articles, stock prices, weather, etc. Supports natural language queries, can also directly input URL to get webpage content |
searchKnowledgeBase | CloudBase knowledge base intelligent retrieval tool, supports vector query (vector), fixed document (doc) and OpenAPI document (openapi) queries. It is strongly recommended to always prioritize using fixed document (doc) or OpenAPI document (openapi) mode for retrieval, only use vector query (vector) mode when fixed documents cannot cover your question. Fixed document (doc) query currently supports 16 fixed documents, which are: Document name: auth-http-api Document introduction: Use when you need to implement CloudBase Auth v2 over raw HTTP endpoints (login/signup, tokens, user operations) from backends or scripts that are not using the Web or Node SDKs. Document name: auth-nodejs Document introduction: Complete guide for CloudBase Auth using the CloudBase Node SDK – caller identity, user lookup, custom login tickets, and server-side best practices. Document name: auth-web Document introduction: Complete guide for CloudBase Auth v2 using Web SDK (@cloudbase/js-sdk@2.x) - all login flows, user management, captcha handling, and best practices in one file. Document name: auth-wechat Document introduction: Complete guide for WeChat Mini Program authentication with CloudBase - native login, user identity, and cloud function integration. Document name: cloudbase-platform Document introduction: CloudBase platform knowledge and best practices. Use this skill for general CloudBase platform understanding, including storage, hosting, authentication, cloud functions, database permissions, and data models. Document name: cloudrun-development Document introduction: CloudBase Run backend development rules (Function mode/Container mode). Use this skill when deploying backend services that require long connections, multi-language support, custom environments, or AI agent development. Document name: data-model-creation Document introduction: Optional advanced tool for complex data modeling. For simple table creation, use relational-database-tool directly with SQL statements. Document name: http-api Document introduction: Use CloudBase HTTP API to access CloudBase platform features (database, authentication, cloud functions, cloud hosting, cloud storage, AI) via HTTP protocol from backends or scripts that are not using SDKs. Document name: miniprogram-development Document introduction: WeChat Mini Program development rules. Use this skill when developing WeChat mini programs, integrating CloudBase capabilities, and deploying mini program projects. Document name: no-sql-web-sdk Document introduction: Use CloudBase document database Web SDK to query, create, update, and delete data. Supports complex queries, pagination, aggregation, and geolocation queries. Document name: no-sql-wx-mp-sdk Document introduction: Use CloudBase document database WeChat MiniProgram SDK to query, create, update, and delete data. Supports complex queries, pagination, aggregation, and geolocation queries. Document name: relational-database-tool Document introduction: This is the required documentation for agents operating on the CloudBase Relational Database. It lists the only four supported tools for running SQL and managing security rules. Read the full content to understand why you must NOT use standard Application SDKs and how to safely execute INSERT, UPDATE, or DELETE operations without corrupting production data. Document name: relational-database-web Document introduction: Use when building frontend Web apps that talk to CloudBase Relational Database via @cloudbase/js-sdk – provides the canonical init pattern so you can then use Supabase-style queries from the browser. Document name: spec-workflow Document introduction: Standard software engineering workflow for requirement analysis, technical design, and task planning. Use this skill when developing new features, complex architecture designs, multi-module integrations, or projects involving database/UI design. Document name: ui-design Document introduction: Professional UI design and frontend interface guidelines. Use this skill when creating web pages, mini-program interfaces, prototypes, or any frontend UI components that require distinctive, production-grade design with exceptional aesthetic quality. Document name: web-development Document introduction: Web frontend project development rules. Use this skill when developing web frontend pages, deploying static hosting, and integrating CloudBase Web SDK. OpenAPI document (openapi) query currently supports 5 API documents, which are: API name: mysqldb API introduction: MySQL RESTful API - CloudBase MySQL database HTTP API API name: functions API introduction: Cloud Functions API - Cloud function HTTP API API name: storage API introduction: Storage API - Cloud storage HTTP API API name: cloudrun API introduction: CloudRun API - Cloud hosting service HTTP API API name: auth API introduction: Authentication API - Identity authentication HTTP API |
queryCloudRun | Query cloud hosting service information, supports getting service list, querying service details and getting available template list. Returned service information includes service name, status, access type, configuration details, etc. |
manageCloudRun | Manage cloud hosting services, supports in development order: initialize project (can start from template, template list can be queried through queryCloudRun), download service code, run locally (function mode services only), deploy code, delete service. Deployment can configure CPU, memory, instance count, access type and other parameters. Delete operation requires confirmation, it is recommended to set force=true. |
createFunctionHTTPAccess | Create cloud function HTTP access |
downloadRemoteFile | Download remote file to specified relative path under project root directory. For example: Mini program Tabbar and other material images, must use **png** format, can choose from Unsplash, wikimedia [generally choose 500 size], Pexels, Apple official UI and other resources to download. |
readSecurityRule | Read security rules and permission categories for specified resources (noSQL database, SQL database, cloud function, storage bucket). |
writeSecurityRule | Set security rules for specified resources (database collection, cloud function, storage bucket). |
activateInviteCode | CloudBase AI programming incentive program, activate user incentives through invite code. |
Detailed Specifications
login
Login to CloudBase environment. MUST call this tool first before generating any CloudBase-related functionality. Login to CloudBase environment and select the environment to use.
Parameters
| Parameter Name | Type | Required | Description |
|---|---|---|---|
forceUpdate | boolean | Whether to force re-select environment |
logout
Logout from CloudBase environment
Parameters
| Parameter Name | Type | Required | Description |
|---|---|---|---|
confirm | string | Yes | Confirm operation, default pass yes Available values: const "yes" |
envQuery
Query CloudBase environment related information, supports querying environment list, current environment information, security domains and static website hosting configuration. (Original tool names: listEnvs/getEnvInfo/getEnvAuthDomains/getWebsiteConfig, these names can still be used for compatibility with old AI rules)
Parameters
| Parameter Name | Type | Required | Description |
|---|---|---|---|
action | string | Yes | Query type: list=environment list, info=current environment information, domains=security domain list, hosting=static website hosting configuration Available values: "list", "info", "domains", "hosting" |
envDomainManagement
Manage CloudBase environment security domains, supports add and delete operations. (Original tool names: createEnvDomain/deleteEnvDomain, these names can still be used for compatibility with old AI rules)
Parameters
| Parameter Name | Type | Required | Description |
|---|---|---|---|
action | string | Yes | Operation type: create=add domain, delete=delete domain Available values: "create", "delete" |
domains | array of string | Yes | Security domain array |
Note: Due to the length of this file, the remaining tool specifications follow the same pattern. The full file would continue with detailed specifications for all 37 tools.