MCP Tools

Currently includes 36 tools.

Source data: tools.json

---

Tool Overview

Name	Description
auth	CloudBase (Tencent Cloud Development) development stage login and environment binding. After logging in, you can access cloud resources; an environment (env) is an isolation unit for cloud functions, databases, static hosting and other resources. After binding the environment, other MCP tools can operate on that environment. Supports: query status, initiate login, bind environment (set_env), logout.
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) When action=list, standard return fields are EnvId, Alias, Status, EnvType, Region, PackageId, PackageName, IsDefault, and supports filtering these fields via fields whitelist; aliasExact=true will filter by exact alias match to avoid mistaking environments with similar prefixes as candidates; even if envId is passed, action=list only returns summary, not complete resource details or expiry. To query detailed information of a known environment, use action=info. action=info will supplement BillingInfo (such as ExpireTime, PayMode, IsAutoRenew and other billing fields) when available.
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) When browser Web applications need to directly access CloudBase resources from local Vite / dev server or custom domains, first use envQuery(action=domains) to check if the actual browser origin's host:port is already in the whitelist, then add based on that actual value.
readNoSqlDatabaseStructure	Read NoSQL database collection and index structure, supports listing collections, viewing collection details, listing indexes, and checking if an index exists.
writeNoSqlDatabaseStructure	Modify NoSQL database structure, supports creating/deleting collections, and adding/deleting indexes via updateCollection's updateOptions.CreateIndexes / updateOptions.DropIndexes.
readNoSqlDatabaseContent	Query and get NoSQL database data records
writeNoSqlDatabaseContent	Modify NoSQL database data records. Think in terms of MongoDB updateOne/updateMany: partial updates must use update operators such as $set, $inc, and $push; if you pass a plain object like { field: value }, the underlying layer treats it as replacement content and may overwrite the entire document. When updating a nested field, you must use dot-notation paths, for example { "$set": { "address.city": "shenzhen" } }; if you write { "$set": { "address": { "city": "shenzhen" } } }, the entire address object will be replaced and sibling fields will be lost. If role/profile documents are read on the frontend via db.collection(...).doc(uid), ensure the document _id is that uid; do not update users or profiles with query={"uid":"..."} plus upsert=true, otherwise a different _id may be created and later doc(uid) reads will miss.
querySqlDatabase	Query SQL database information. Supports read-only SQL execution, MySQL provisioning result lookup, MySQL task status lookup, and current instance context discovery.
manageSqlDatabase	Manage SQL database resources. Supports MySQL provisioning, MySQL destruction, write SQL/DDL execution, and schema initialization. IMPORTANT: MySQL must be provisioned first (action=provisionMySQL with confirm=true) before any runStatement or initializeSchema call. If MySQL is not yet provisioned, the tool will return MYSQL_NOT_CREATED with a nextAction to provision first.
manageDataModel	Data model query tool, supports querying and listing data models (read-only operations). Use the action parameter to distinguish operation types: list=get model list (without Schema, optional names parameter for filtering), get=query single model details (with Schema field list, format, relationships, etc., requires name parameter), docs=generate SDK usage documentation (requires name parameter)
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.
queryFunctions	Unified read-only entry for the functions domain. Query function list, function details, logs, layers, triggers, and code download URLs via self-explanatory action names.
manageFunctions	Unified write entry for the functions domain. Manage function creation, code updates, config updates, function invocation, triggers, and layer bindings via action. Dangerous operations require explicit confirm=true.
uploadFiles	Upload files to static website hosting, only for Web site deployment, not for cloud storage object uploads. Please complete the build before deployment; if the site will be deployed to a subpath, check if publicPath, base, assetPrefix, etc. in the build configuration use relative paths to avoid static resource loading failures. For uploading COS cloud storage files, use manageStorage. For local evaluation, existing scaffold completion, or tasks that only need local dev server verification, this tool is usually not needed unless the user explicitly requests site deployment.
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, only for COS/Storage objects, not for static website hosting. 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 - cursor: Cursor AI editor - Other IDE types see list below Note: If ide parameter is not passed and IDE cannot be detected from environment, an error will be prompted and require passing ide parameter - 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 - qoder: Qoder AI editor - antigravity: Google Antigravity AI editor - vscode: Visual Studio Code - kiro: Kiro AI editor - aider: Aider AI editor Special notes: - rules template will automatically include current mcp version information (version: 2.17.1) 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)
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 skill documents (skill), OpenAPI documents (openapi) and CloudBase official documentation (docs) queries. It is strongly recommended to always prioritize using fixed skill documents (skill), OpenAPI documents (openapi) or CloudBase official documentation (docs) mode for retrieval, only use vector query (vector) mode when fixed documents cannot cover your question. Fixed skill documents (skill) query currently supports 24 fixed documents, they are: Document name: skills - Document description: Unified CloudBase execution guide for all-in-one skill installs. Use this as the first entry point for CloudBase app tasks, especially existing applications that already contain TODOs, fixed pages, and active handlers. Document name: ai-model-nodejs - Document description: Use this skill when developing Node.js backend services or CloudBase cloud functions (Express/Koa/NestJS, serverless, backend APIs) that need AI capabilities. Features text generation (generateText), streaming (streamText), AND image generation (generateImage) via @cloudbase/node-sdk ≥3.16.0. Built-in models include Hunyuan (hunyuan-2.0-instruct-20251111 recommended), DeepSeek (deepseek-v3.2 recommended), and hunyuan-image for images. This is the ONLY SDK that supports image generation. NOT for browser/Web apps (use ai-model-web) or WeChat Mini Program (use ai-model-wechat). Document name: ai-model-web - Document description: Use this skill when developing browser/Web applications (React/Vue/Angular, static websites, SPAs) that need AI capabilities. Features text generation (generateText) and streaming (streamText) via @cloudbase/js-sdk. Built-in models include Hunyuan (hunyuan-2.0-instruct-20251111 recommended) and DeepSeek (deepseek-v3.2 recommended). NOT for Node.js backend (use ai-model-nodejs), WeChat Mini Program (use ai-model-wechat), or image generation (Node SDK only). Document name: ai-model-wechat - Document description: Use this skill when developing WeChat Mini Programs (小程序, 企业微信小程序, wx.cloud-based apps) that need AI capabilities. Features text generation (generateText) and streaming (streamText) with callback support (onText, onEvent, onFinish) via wx.cloud.extend.AI. Built-in models include Hunyuan (hunyuan-2.0-instruct-20251111 recommended) and DeepSeek (deepseek-v3.2 recommended). API differs from JS/Node SDK - streamText requires data wrapper, generateText returns raw response. NOT for browser/Web apps (use ai-model-web), Node.js backend (use ai-model-nodejs), or image generation (not supported). Document name: auth-nodejs - Document description: CloudBase Node SDK auth guide for server-side identity, user lookup, and custom login tickets. This skill should be used when Node.js code must read caller identity, inspect end users, or bridge an existing user system into CloudBase; not when configuring providers or building client login UI. Document name: auth-tool - Document description: CloudBase auth provider configuration and login-readiness guide. This skill should be used when users need to inspect, enable, disable, or configure auth providers, publishable-key prerequisites, login methods, SMS/email sender setup, or other provider-side readiness before implementing a client or backend auth flow. Document name: auth-web - Document description: CloudBase Web Authentication Quick Guide for frontend integration after auth-tool has already been checked. Provides concise and practical Web authentication solutions with multiple login methods and complete user management. Document name: auth-wechat - Document description: CloudBase WeChat Mini Program native authentication guide. This skill should be used when users need mini program identity handling, OPENID/UNIONID access, or `wx.cloud` auth behavior in projects where login is native and automatic. Document name: cloud-functions - Document description: CloudBase function runtime guide for building, deploying, and debugging your own Event Functions or HTTP Functions. This skill should be used when users need application runtime code on CloudBase, not when they are merely calling CloudBase official platform APIs. Document name: cloud-storage-web - Document description: Complete guide for CloudBase cloud storage using Web SDK (@cloudbase/js-sdk) - upload, download, temporary URLs, file management, and best practices. Document name: cloudbase-agent - Document description: Build and deploy AI agents with CloudBase Agent SDK (TypeScript & Python). Implements the AG-UI protocol for streaming agent-UI communication. Use when deploying agent servers, using LangGraph/LangChain/CrewAI adapters, building custom adapters, understanding AG-UI protocol events, or building web/mini-program UI clients. Supports both TypeScript (@cloudbase/agent-server) and Python (cloudbase-agent-server via FastAPI). Document name: cloudbase-platform - Document description: CloudBase platform overview and routing guide. This skill should be used when users need high-level capability selection, platform concepts, console navigation, or cross-platform best practices before choosing a more specific implementation skill. Document name: cloudrun-development - Document description: 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 description: Optional advanced tool for complex data modeling. For simple table creation, use relational-database-tool directly with SQL statements. Document name: http-api - Document description: CloudBase official HTTP API client guide. This skill should be used when backends, scripts, or non-SDK clients must call CloudBase platform APIs over raw HTTP instead of using a platform SDK or MCP management tool. Document name: miniprogram-development - Document description: WeChat Mini Program development skill for building, debugging, previewing, testing, publishing, and optimizing mini program projects. This skill should be used when users ask to create, develop, modify, debug, preview, test, deploy, publish, launch, review, or optimize WeChat Mini Programs, mini program pages, components, routing, project structure, project configuration, project.config.json, appid setup, device preview, real-device validation, WeChat Developer Tools workflows, miniprogram-ci preview/upload flows, or mini program release processes. It should also be used when users explicitly mention CloudBase, wx.cloud, Tencent CloudBase, 腾讯云开发, or 云开发 in a mini program project. Document name: no-sql-web-sdk - Document description: Use CloudBase document database Web SDK to query, create, update, and delete data. Supports complex queries, pagination, aggregation, realtime, and geolocation queries. Document name: no-sql-wx-mp-sdk - Document description: Use CloudBase document database WeChat MiniProgram SDK to query, create, update, and delete data. Supports complex queries, pagination, aggregation, and geolocation queries. Document name: ops-inspector - Document description: AIOps-style one-click inspection skill for CloudBase resources. Use this skill when users need to diagnose errors, check resource health, inspect logs, or run a comprehensive health check across cloud functions, CloudRun services, databases, and other CloudBase resources. Document name: relational-database-tool - Document description: This is the required documentation for agents operating on the CloudBase Relational Database through MCP. It defines the canonical SQL management flow with `querySqlDatabase`, `manageSqlDatabase`, `queryPermissions`, and `managePermissions`, including MySQL provisioning, destroy flow, async status checks, safe query execution, schema initialization, and permission updates. Document name: relational-database-web - Document description: 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 description: Use when medium-to-large changes need explicit requirements, technical design, and task planning before implementation, especially for multi-module work, unclear acceptance criteria, or architecture-heavy requests. Document name: ui-design - Document description: Use when users need visual direction, interface hierarchy, layout decisions, design specifications, or prototypes before implementing a Web or mini program UI. Document name: web-development - Document description: Use when users need to implement, integrate, debug, build, deploy, or validate a Web frontend after the product direction is already clear, especially for React, Vue, Vite, browser flows, or CloudBase Web integration. OpenAPI documents (openapi) query currently supports 5 API documents, they are: API name: functions - API description: Cloud Functions API - Cloud Functions HTTP API API name: storage - API description: Storage API - Cloud Storage HTTP API API name: mysqldb - API description: MySQL RESTful API - CloudBase MySQL Database HTTP API API name: auth - API description: Authentication API - Identity Authentication HTTP API API name: cloudrun - API description: CloudRun API - CloudRun Service HTTP API
queryCloudRun	Query CloudRun 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 CloudRun 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.
queryGateway	Unified read-only entry for the gateway domain. Query gateway domains, access entries, and target exposure status via action.
manageGateway	Unified write entry for the gateway domain. Create target access entries via action, with more general gateway configuration capabilities to follow.
queryAppAuth	Read-only entry for application-side authentication configuration. Used to query login methods, providers, publishable key, API key, client configuration, and static domain authentication readiness status. If the business needs to accept plain username-style identifiers, first query action=getLoginConfig; if usernamePassword=false, the next step should immediately call manageAppAuth(action=patchLoginStrategy, patch={ usernamePassword: true }), do not directly write email login API.
manageAppAuth	Write entry for application-side authentication configuration. Used to modify login methods, providers, client configuration, ensure publishable key, and create or delete API keys and custom login keys. If the frontend needs to accept plain username-style identifiers, first execute action=patchLoginStrategy with patch={ usernamePassword: true }, then implement the corresponding frontend login logic.
queryPermissions	Unified read-only entry for the permissions domain. Supports querying resource permissions, role list/details, and application user list/details.
managePermissions	Unified write entry for the permissions domain. Supports modifying resource permissions, role management, member and policy add/remove, and application user CRUD. `createUser` / `updateUser` are environment-side application user management capabilities, suitable for test accounts, administrators, or preset users, and should not replace browser-side Web SDK registration forms; frontend username password registration should use `auth.signUp({ username, password })`, login should use `auth.signInWithPassword({ username, password })`. Note: The detailed semantics of `securityRule` depend on `resourceType`; `doc._openid`, `auth.openid`, query condition subset validation, and `create` / `update` / `delete` JSON templates only apply to `resourceType="noSqlDatabase"` document database security rules. When configuring `function` or `storage`, please refer to their respective official security rule documentation, not reuse NoSQL templates.
queryLogs	Unified read-only entry for the logs domain. Supports checking log service status and searching CLS logs.
queryAgents	Unified read-only entry for the Agent domain. Supports listing, details, and log queries.
manageAgents	Unified write entry for the Agent domain. Supports creating, updating, and deleting remote Agents.
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.
activateInviteCode	CloudBase AI programming incentive program, activate user incentives through invite code.
callCloudApi	General cloud API calling tool, mainly used for CloudBase / Tencent Cloud management plane and dependent resource related API calls. Before calling, please confirm service, Action and Param first, avoid guessing Action names. If your goal is to directly integrate auth/functions/cloudrun/storage/mysqldb and other CloudBase business APIs via HTTP protocol, do not prioritize using callCloudApi, instead prioritize checking the corresponding OpenAPI / Swagger. The existing OpenAPI / Swagger capabilities are not a general management plane Action collection; for management plane APIs, please prioritize referring to CloudBase API Overview https://cloud.tencent.com/document/product/876/34809 and CloudBase Dependent Resource API Guide https://cloud.tencent.com/document/product/876/34808. For tcb service, common Action categories are as follows: **Environment Management**: `CreateEnv`, `ModifyEnv`, `DescribeEnvs`, `DestroyEnv` **User Management**: `CreateUser`, `ModifyUser`, `DescribeUserList`, `DeleteUsers` **Authentication Configuration**: `EditAuthConfig`, `DescribeAuthDomains` **Cloud Functions**: `DescribeFunctions`, `CreateFunction`, `UpdateFunctionCode`, `DeleteFunction` **Database**: `CreateMySQLInstance`, `DescribeMySQLInstances`, `DestroyMySQLInstance` When destroying an environment, the common practice is to at least include `EnvId` and `BypassCheck: true`; if the environment is already in isolation period, add `IsForce: true` per documentation.

---

Hosted MCP Configuration

Environment Variable Configuration

Using hosted MCP requires configuring the following environment variables:

Environment Variable	Description	How to Obtain
TENCENTCLOUD_SECRETID	Tencent Cloud SecretId	Get Tencent Cloud API Key
TENCENTCLOUD_SECRETKEY	Tencent Cloud SecretKey	Get Tencent Cloud API Key
TENCENTCLOUD_SESSIONTOKEN	Optional, Tencent Cloud temporary key Token	Only needed when using temporary keys, can be obtained via STS Service
CLOUDBASE_ENV_ID	CloudBase Environment ID	Get CloudBase Environment ID

Detailed Specs

auth

CloudBase (Tencent Cloud Development) development stage login and environment binding. After logging in, you can access cloud resources; an environment (env) is an isolation unit for cloud functions, databases, static hosting and other resources. After binding the environment, other MCP tools can operate on that environment. Supports: query status, initiate login, bind environment (set_env), logout.

Parameters

Parameter	Type	Required	Description
action	string		Action: status=query status, start_auth=initiate login, set_env=bind environment (pass envId), logout=logout. Allowed values: "status", "start_auth", "set_env", "logout", "get_temp_credentials"
authMode	string		Authentication mode: device=device code authorization, web=browser callback authorization. Allowed values: "device", "web"
oauthEndpoint	string		Advanced optional: Custom device-code login endpoint. When configured, oauthCustom defaults to true
clientId	string		Advanced optional: Custom device-code login client_id, uses default value if not provided
oauthCustom	boolean		Advanced optional: Custom endpoint return format switch. Defaults to false when endpoint not configured; defaults to true when endpoint is configured and cannot be set to false
envId	string		Environment ID (CloudBase environment unique identifier), after binding the tool will operate on this environment. Required when action=set_env
confirm	string		Confirm operation when action=logout, pass yes. Allowed values: const "yes"
reveal	boolean		Optional when action=get_temp_credentials. true=return plaintext temporary credentials; defaults to false returning masked results only

---

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) When action=list, standard return fields are EnvId, Alias, Status, EnvType, Region, PackageId, PackageName, IsDefault, and supports filtering these fields via fields whitelist; aliasExact=true will filter by exact alias match to avoid mistaking environments with similar prefixes as candidates; even if envId is passed, action=list only returns summary, not complete resource details or expiry. To query detailed information of a known environment, use action=info. action=info will supplement BillingInfo (such as ExpireTime, PayMode, IsAutoRenew and other billing fields) when available.

Parameters

Parameter	Type	Required	Description
action	string	Yes	Query type: list=environment list/summary filtering (even if envId is passed, only returns EnvId, Alias, Status, EnvType, Region, PackageId, PackageName, IsDefault, does not support expiry), info=current environment detailed information (details can show more complete resource fields), domains=security domain list, hosting=static website hosting configuration. Allowed values: "list", "info", "domains", "hosting"
alias	string		Filter by environment alias. Optional when action=list
aliasExact	boolean		Filter by exact environment alias match. Optional when action=list; used together with alias
envId	string		Filter by exact environment ID. Optional when action=list; note list + envId still only returns summary, for environment details use action=info
limit	integer		Maximum number of results to return. Optional when action=list
offset	integer		Pagination offset. Optional when action=list
fields	array of string		Return field whitelist. Only supports EnvId, Alias, Status, EnvType, Region, PackageId, PackageName, IsDefault. Optional when action=list

---

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) When browser Web applications need to directly access CloudBase resources from local Vite / dev server or custom domains, first use envQuery(action=domains) to check if the actual browser origin's host:port is already in the whitelist, then add based on that actual value.

Parameters

Parameter	Type	Required	Description
action	string	Yes	Operation type: create=add domain, delete=delete domain. Allowed values: "create", "delete"
domains	array of string	Yes	Security domain array

---

readNoSqlDatabaseStructure

Read NoSQL database collection and index structure, supports listing collections, viewing collection details, listing indexes, and checking if an index exists.

Parameters

Parameter	Type	Required	Description
action	string	Yes	listCollections: List collection list describeCollection: Describe collection details (returns index summary) checkCollection: Check if collection exists listIndexes: List indexes of specified collection checkIndex: Check if specified index exists. Allowed values: "listCollections", "describeCollection", "checkCollection", "listIndexes", "checkIndex"
limit	number		Return count limit (optional for listCollections operation)
offset	number		Offset (optional for listCollections operation)
collectionName	string		Collection name (required for describeCollection, listIndexes, checkIndex operations)
indexName	string		Index name (required for checkIndex operation)

---

writeNoSqlDatabaseStructure

Modify NoSQL database structure, supports creating/deleting collections, and adding/deleting indexes via updateCollection's updateOptions.CreateIndexes / updateOptions.DropIndexes.

Parameters

Parameter	Type	Required	Description
action	string	Yes	createCollection: Create collection updateCollection: Update collection configuration; pass updateOptions.CreateIndexes to add indexes, pass updateOptions.DropIndexes to delete indexes deleteCollection: Delete collection. Allowed values: "createCollection", "updateCollection", "deleteCollection"
collectionName	string	Yes	Collection name
updateOptions	object		Update options (used for updateCollection). CreateIndexes for adding indexes, DropIndexes for deleting indexes.
updateOptions.CreateIndexes	array of object		List of indexes to add
updateOptions.CreateIndexes[].IndexName	string	Yes	Index name to create
updateOptions.CreateIndexes[].MgoKeySchema	object	Yes	Field and constraint configuration for index to be created
updateOptions.CreateIndexes[].MgoKeySchema.MgoIsUnique	boolean	Yes	Whether unique index
updateOptions.CreateIndexes[].MgoKeySchema.MgoIndexKeys	array of object	Yes	Index field list, supports single field or compound indexes
updateOptions.CreateIndexes[].MgoKeySchema.MgoIndexKeys[].Name	string	Yes	Index field name
updateOptions.CreateIndexes[].MgoKeySchema.MgoIndexKeys[].Direction	string	Yes	Index direction, typically 1 for ascending, -1 for descending
updateOptions.DropIndexes	array of object		List of indexes to delete
updateOptions.DropIndexes[].IndexName	string	Yes	Index name to delete

---

readNoSqlDatabaseContent

Query and get NoSQL database data records

Parameters

Parameter	Type	Required	Description
collectionName	string	Yes	Collection name
instanceId	string		Optional: Explicitly specify database instance ID; will be automatically resolved and cached if not provided
query	object | string		Query conditions (object or string, object recommended)
projection	object | string		Return field projection (object or string, object recommended)
sort	array of object | string		Sort conditions, only supports array [{"key":"createdAt","direction":-1}] or corresponding JSON string.
limit	number		Return count limit
offset	number		Number of records to skip

---

writeNoSqlDatabaseContent

Modify NoSQL database data records. Can be understood using MongoDB updateOne/updateMany mental model: partial updates must use update operators like $set/$inc/$push; if you directly pass a plain object like { field: value }, the underlying layer treats it as replacement content, risking overwriting the entire document. When updating a field in a nested object, you must use dot notation path (e.g., { "$set": { "address.city": "shenzhen" } }); if written as { "$set": { "address": { "city": "shenzhen" } } }, the entire address object will be replaced and other sibling fields will be lost. If role/profile documents in a collection are read on the frontend via db.collection(...).doc(uid), ensure the document _id is that uid; do not use query={"uid":"..."} + upsert=true to update users / profiles, otherwise it often generates a different _id, causing subsequent doc(uid) reads to miss.

Parameters

Parameter	Type	Required	Description
action	string	Yes	insert: Insert data (add document) update: Update data delete: Delete data. Allowed values: "insert", "update", "delete"
collectionName	string	Yes	Collection name
instanceId	string		Optional: Explicitly specify database instance ID; will be automatically resolved and cached if not provided
documents	array of object		Array of document objects to insert, each document is an object (required for insert operation)
query	object | string		Query conditions (object or string, object recommended) (required for update/delete operations)
update	object | string		Update content (object or string, object recommended) (required for update operation). Pass MgoUpdate using MongoDB update semantics: for partial updates use $set/$inc/$unset/$push operators, e.g., { "$set": { "status": "pending" } }; do not directly pass { "status": "pending" }, otherwise the entire document may be replaced. When updating nested fields, use dot notation path, e.g., { "$set": { "address.city": "shenzhen" } }, do not write { "$set": { "address": { "city": "shenzhen" } } } (will replace entire address object).
isMulti	boolean		Whether to update multiple records (optional for update/delete operations)
upsert	boolean		Whether to insert if not exists (optional for update operation)

---

querySqlDatabase

Query SQL database information. Supports read-only SQL execution, MySQL provisioning result lookup, MySQL task status lookup, and current instance context discovery.

Parameters

Parameter	Type	Required	Description
action	string	Yes	runQuery=execute read-only SQL; describeCreateResult=query CreateMySQL result; describeTaskStatus=query MySQL task status; getInstanceInfo=get current SQL instance context. Allowed values: "runQuery", "describeCreateResult", "describeTaskStatus", "getInstanceInfo"
sql	string		Read-only SQL used by action=runQuery
request	object		Official request payload used by describeCreateResult/describeTaskStatus
dbInstance	object		Optional SQL database instance context for runQuery
dbInstance.instanceId	string
dbInstance.schema	string

---

manageSqlDatabase

Manage SQL database resources. Supports MySQL provisioning, MySQL destruction, write SQL/DDL execution, and schema initialization. IMPORTANT: MySQL must be provisioned first (action=provisionMySQL with confirm=true) before any runStatement or initializeSchema call. If MySQL is not yet provisioned, the tool will return MYSQL_NOT_CREATED with a nextAction to provision first.

Parameters

Parameter	Type	Required	Description
action	string	Yes	provisionMySQL=create MySQL instance; destroyMySQL=destroy MySQL instance; runStatement=execute write SQL or DDL; initializeSchema=run ordered schema initialization statements. Allowed values: "provisionMySQL", "destroyMySQL", "runStatement", "initializeSchema"
confirm	boolean		Explicit confirmation required for action=provisionMySQL or action=destroyMySQL
sql	string		SQL statement used by action=runStatement
request	object		Official request payload used by action=provisionMySQL or action=destroyMySQL
statements	array of string		Ordered schema initialization SQL statements used by action=initializeSchema
requireReady	boolean		Whether initializeSchema should block until MySQL is confirmed ready. Defaults to true.
statusContext	object		Optional provisioning status requests used to confirm readiness before initializeSchema
statusContext.createResultRequest	object
statusContext.taskStatusRequest	object
dbInstance	object		Optional SQL database instance context for runStatement/initializeSchema
dbInstance.instanceId	string
dbInstance.schema	string

---

manageDataModel

Data model query tool, supports querying and listing data models (read-only operations). Use the action parameter to distinguish operation types: list=get model list (without Schema, optional names parameter for filtering), get=query single model details (with Schema field list, format, relationships, etc., requires name parameter), docs=generate SDK usage documentation (requires name parameter)

Parameters

Parameter	Type	Required	Description
action	string	Yes	Operation type: get=query single model (with Schema field list, format, relationships, requires name parameter), list=get model list (without Schema, optional names parameter for filtering), docs=generate SDK usage documentation (requires name parameter). Allowed values: "get", "list", "docs"
name	string		Data model name to query. When action='get' or action='docs', this parameter is required and must provide an existing data model name. Available model names can be obtained via action='list' operation
names	array of string		Model name array (optional for list operation, for filtering)

---

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.

Parameters

Parameter	Type	Required	Description
mermaidDiagram	string	Yes	Mermaid classDiagram code describing the data model structure.
action	string		Operation type: create=create new model. Allowed values: "create"; Default: "create"
publish	boolean		Whether to publish the model immediately. Default: false
dbInstanceType	string		Database instance type. Default: "MYSQL"

Example

classDiagram
    class Student {
        name: string <<Name>>
        age: number = 18 <<Age>>
        gender: x-enum = "Male" <<Gender>>
        classId: string <<Class ID>>
        identityId: string <<Identity ID>>
        course: Course[] <<Courses>>
        required() ["name"]
        unique() ["name"]
        enum_gender() ["Male", "Female"]
        display_field() "name"
    }
    class Class {
        className: string <<Class Name>>
        display_field() "className"
    }
    class Course {
        name: string <<Course Name>>
        students: Student[] <<Students>>
        display_field() "name"
    }
    class Identity {
        number: string <<ID Number>>
        display_field() "number"
    }

    %% Relationships
    Student "1" --> "1" Identity : studentId
    Student "n" --> "1" Class : student2class
    Student "n" --> "m" Course : course
    Student "n" <-- "m" Course : students
    %% Class naming
    note for Student "Student Model"
    note for Class "Class Model"
    note for Course "Course Model"
    note for Identity "Identity Model"

---

queryFunctions

Unified read-only entry for the functions domain. Query function list, function details, logs, layers, triggers, and code download URLs via self-explanatory action names.

Parameters

Parameter	Type	Required	Description
action	string	Yes	Read-only operation type, e.g., listFunctions, getFunctionDetail, listFunctionLogs. Allowed values: "listFunctions", "getFunctionDetail", "listFunctionLogs", "getFunctionLogDetail", "listFunctionLayers", "listLayers", "listLayerVersions", "getLayerVersionDetail", "listFunctionTriggers", "getFunctionDownloadUrl"
functionName	string		Function name. Required for function-related actions
limit	number		Pagination count. Optional for list-type actions
offset	number		Pagination offset. Optional for list-type actions
codeSecret	string		Code protection secret
startTime	string		Log query start time
endTime	string		Log query end time
requestId	string		Log requestId. Required when getting log details
qualifier	string		Function version, optional for log queries
runtime	string		Runtime filter for layer queries
searchKey	string		Layer name search keyword
layerName	string		Layer name. Required for layer-related actions
layerVersion	number		Layer version number. Required when getting layer version details

---

manageFunctions

Unified write entry for the functions domain. Manage function creation, code updates, config updates, function invocation, triggers, and layer bindings via action. Dangerous operations require explicit confirm=true.

Parameters

Parameter	Type	Required	Description
action	string	Yes	Write operation type, e.g., createFunction, invokeFunction, attachLayer. Allowed values: "createFunction", "updateFunctionCode", "updateFunctionConfig", "invokeFunction", "createFunctionTrigger", "deleteFunctionTrigger", "createLayerVersion", "deleteLayerVersion", "attachLayer", "detachLayer", "updateFunctionLayers"
func	object		Function configuration for createFunction operation
func.name	string	Yes	Function name
func.type	string		Function type. Allowed values: "Event", "HTTP"
func.protocolType	string		HTTP cloud function protocol type. Allowed values: "HTTP", "WS"
func.protocolParams	object
func.protocolParams.wsParams	object
func.protocolParams.wsParams.idleTimeOut	number		WebSocket idle timeout (seconds)
func.instanceConcurrencyConfig	object
func.instanceConcurrencyConfig.dynamicEnabled	boolean
func.instanceConcurrencyConfig.maxConcurrency	number
func.timeout	number		Function timeout
func.envVariables	object		Environment variables
func.vpc	object		VPC configuration
func.vpc.vpcId	string	Yes
func.vpc.subnetId	string	Yes
func.runtime	string		Runtime environment. Event functions support multiple runtimes: Nodejs: Nodejs20.19, Nodejs18.15, Nodejs16.13, Nodejs14.18, Nodejs12.16, Nodejs10.15, Nodejs8.9 Python: Python3.10, Python3.9, Python3.7, Python3.6, Python2.7 Php: Php8.0, Php7.4, Php7.2 Java: Java8, Java11 Golang: Golang1 Recommended runtimes: Node.js: Nodejs18.15 Python: Python3.9 PHP: Php7.4 Java: Java11 Go: Golang1
func.triggers	array of object		Trigger configuration array
func.triggers[].name	string	Yes	Trigger name
func.triggers[].type	string	Yes	Trigger type. Allowed values: "timer"
func.triggers[].config	string	Yes	Trigger configuration, timer uses 7-segment cron: second minute hour day month week year
func.handler	string		Function entry point
func.ignore	string | array of string		Ignored files
func.isWaitInstall	boolean		Whether to wait for dependency installation
func.layers	array of object		Layer configuration
func.layers[].name	string	Yes
func.layers[].version	number	Yes
functionRootPath	string		Function root directory (parent directory absolute path)
force	boolean		Whether to overwrite when createFunction
functionName	string		Function name. Most actions use this field as unified target
zipFile	string		Code package base64 encoding
handler	string		Function entry point
timeout	number		Timeout for config update
envVariables	object		Environment variables to merge for config update
vpc	unknown		VPC info for config update
params	object		Invocation parameters for invokeFunction
triggers	array of unknown		Trigger list for createFunctionTrigger
triggerName	string		Target trigger name for deleteFunctionTrigger
layerName	string		Layer name
layerVersion	number		Layer version number
contentPath	string		Layer content path, can be directory or ZIP file
base64Content	string		Layer content base64 encoding
runtimes	array of string		List of runtimes the layer applies to
description	string		Layer version description
licenseInfo	string		Layer license information
layers	array of object		Target layer list for updateFunctionLayers, order is final order
layers[].layerName	string	Yes	Layer name
layers[].layerVersion	number	Yes	Layer version number
codeSecret	string		Code protection secret for layer binding
confirm	boolean		Dangerous operation confirmation switch

---

uploadFiles

Upload files to static website hosting, only for Web site deployment, not for cloud storage object uploads. Please complete the build before deployment; if the site will be deployed to a subpath, check if publicPath, base, assetPrefix, etc. in the build configuration use relative paths to avoid static resource loading failures. For uploading COS cloud storage files, use manageStorage. For local evaluation, existing scaffold completion, or tasks that only need local dev server verification, this tool is usually not needed unless the user explicitly requests site deployment.

Parameters

Parameter	Type	Required	Description
localPath	string		Local file or folder path, must be absolute path, e.g., /tmp/files/data.txt.
cloudPath	string		Static hosting cloud file or folder path, e.g., files/data.txt. If deploying to subpath, also check if publicPath, base, assetPrefix, etc. in build configuration are relative paths. For cloud storage object paths, use manageStorage instead.
files	array of object		Multi-file upload configuration. Default: []
files[].localPath	string	Yes
files[].cloudPath	string	Yes
ignore	string | array of string		Ignored file patterns

---

deleteFiles

Delete static website hosting files or folders

Parameters

Parameter	Type	Required	Description
cloudPath	string	Yes	Cloud file or folder path
isDir	boolean		Whether it is a folder. Default: false

---

findFiles

Search static website hosting files

Parameters

Parameter	Type	Required	Description
prefix	string	Yes	Match prefix
marker	string		Starting object key marker
maxKeys	number		Maximum number of entries to return per request

---

domainManagement

Unified domain management tool, supports binding, unbinding, querying and modifying domain configuration

Parameters

Parameter	Type	Required	Description
action	string	Yes	Operation type: create=bind domain, delete=unbind domain, check=query domain configuration, modify=modify domain configuration. Allowed values: "create", "delete", "check", "modify"
domain	string		Domain
certId	string		Certificate ID (required when binding domain)
domains	array of string		Domain list (used when querying configuration)
domainId	number		Domain ID (required when modifying configuration)
domainConfig	object		Domain configuration (used when modifying configuration)
domainConfig.Refer	object
domainConfig.Refer.Switch	string	Yes
domainConfig.Refer.RefererRules	array of object
domainConfig.Refer.RefererRules[].RefererType	string	Yes
domainConfig.Refer.RefererRules[].Referers	array of string	Yes
domainConfig.Refer.RefererRules[].AllowEmpty	boolean	Yes
domainConfig.Cache	array of object
domainConfig.Cache[].RuleType	string	Yes
domainConfig.Cache[].RuleValue	string	Yes
domainConfig.Cache[].CacheTtl	number	Yes
domainConfig.IpFilter	object
domainConfig.IpFilter.Switch	string	Yes
domainConfig.IpFilter.FilterType	string
domainConfig.IpFilter.Filters	array of string
domainConfig.IpFreqLimit	object
domainConfig.IpFreqLimit.Switch	string	Yes
domainConfig.IpFreqLimit.Qps	number

---

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.

Parameters

Parameter	Type	Required	Description
action	string	Yes	Query operation type: list=list all files in directory, info=get detailed information of specified file, url=get temporary download link for file. Allowed values: "list", "info", "url"
cloudPath	string	Yes	Cloud file path, e.g., files/data.txt or files/ (directory)
maxAge	number		Temporary link validity period in seconds, range: 1-86400, default: 3600 (1 hour). Default: 3600

---

manageStorage

Manage cloud storage files, only for COS/Storage objects, not for static website hosting. 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.

Parameters

Parameter	Type	Required	Description
action	string	Yes	Management operation type: upload=upload file or directory, download=download file or directory, delete=delete file or directory. Allowed values: "upload", "download", "delete"
localPath	string	Yes	Local file path, absolute path recommended, e.g., /tmp/files/data.txt
cloudPath	string	Yes	Cloud file path, e.g., files/data.txt
force	boolean		Force operation switch, recommended to set to true for delete operations to confirm deletion, defaults to false. Default: false
isDirectory	boolean		Whether directory operation, true=directory operation, false=file operation, defaults to false. Default: false

---

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
• cursor: Cursor AI editor
• Other IDE types see list below

Note: If ide parameter is not passed and IDE cannot be detected from environment, an error will be prompted and require passing ide parameter

• 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
• qoder: Qoder AI editor
• antigravity: Google Antigravity AI editor
• vscode: Visual Studio Code
• kiro: Kiro AI editor
• aider: Aider AI editor

Special notes:

• rules template will automatically include current mcp version information (version: 2.17.1) 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)

Parameters

Parameter	Type	Required	Description
template	string	Yes	Template type to download. Allowed values: "react", "vue", "miniprogram", "uniapp", "rules"
ide	string	Yes	Specify the IDE type to download. Allowed values: "all", "cursor", "windsurf", "codebuddy", "claude-code", "cline", "gemini-cli", "opencode", "qwen-code", "baidu-comate", "openai-codex-cli", "augment-code", "github-copilot", "roocode", "tongyi-lingma", "trae", "qoder", "antigravity", "vscode", "kiro", "aider", "iflow-cli"
overwrite	boolean		Whether to overwrite existing files, defaults to false (no overwrite)

---

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

Parameters

Parameter	Type	Required	Description
query	string	Yes	Search keywords, questions or URLs, supports natural language

---

searchKnowledgeBase

CloudBase knowledge base intelligent retrieval tool, supports vector query (vector), fixed skill documents (skill), OpenAPI documents (openapi) and CloudBase official documentation (docs) queries.

  It is strongly recommended to always prioritize using fixed skill documents (skill), OpenAPI documents (openapi) or CloudBase official documentation (docs) mode for retrieval, only use vector query (vector) mode when fixed documents cannot cover your question.

  Fixed skill documents (skill) query currently supports 24 fixed documents, they are:
  Document name: skills - Document description: Unified CloudBase execution guide for all-in-one skill installs. Use this as the first entry point for CloudBase app tasks, especially existing applications that already contain TODOs, fixed pages, and active handlers.

Document name: ai-model-nodejs - Document description: Use this skill when developing Node.js backend services or CloudBase cloud functions (Express/Koa/NestJS, serverless, backend APIs) that need AI capabilities. Features text generation (generateText), streaming (streamText), AND image generation (generateImage) via @cloudbase/node-sdk ≥3.16.0. Built-in models include Hunyuan (hunyuan-2.0-instruct-20251111 recommended), DeepSeek (deepseek-v3.2 recommended), and hunyuan-image for images. This is the ONLY SDK that supports image generation. NOT for browser/Web apps (use ai-model-web) or WeChat Mini Program (use ai-model-wechat). Document name: ai-model-web - Document description: Use this skill when developing browser/Web applications (React/Vue/Angular, static websites, SPAs) that need AI capabilities. Features text generation (generateText) and streaming (streamText) via @cloudbase/js-sdk. Built-in models include Hunyuan (hunyuan-2.0-instruct-20251111 recommended) and DeepSeek (deepseek-v3.2 recommended). NOT for Node.js backend (use ai-model-nodejs), WeChat Mini Program (use ai-model-wechat), or image generation (Node SDK only). Document name: ai-model-wechat - Document description: Use this skill when developing WeChat Mini Programs (小程序, 企业微信小程序, wx.cloud-based apps) that need AI capabilities. Features text generation (generateText) and streaming (streamText) with callback support (onText, onEvent, onFinish) via wx.cloud.extend.AI. Built-in models include Hunyuan (hunyuan-2.0-instruct-20251111 recommended) and DeepSeek (deepseek-v3.2 recommended). API differs from JS/Node SDK - streamText requires data wrapper, generateText returns raw response. NOT for browser/Web apps (use ai-model-web), Node.js backend (use ai-model-nodejs), or image generation (not supported). Document name: auth-nodejs - Document description: CloudBase Node SDK auth guide for server-side identity, user lookup, and custom login tickets. This skill should be used when Node.js code must read caller identity, inspect end users, or bridge an existing user system into CloudBase; not when configuring providers or building client login UI. Document name: auth-tool - Document description: CloudBase auth provider configuration and login-readiness guide. This skill should be used when users need to inspect, enable, disable, or configure auth providers, publishable-key prerequisites, login methods, SMS/email sender setup, or other provider-side readiness before implementing a client or backend auth flow. Document name: auth-web - Document description: CloudBase Web Authentication Quick Guide for frontend integration after auth-tool has already been checked. Provides concise and practical Web authentication solutions with multiple login methods and complete user management. Document name: auth-wechat - Document description: CloudBase WeChat Mini Program native authentication guide. This skill should be used when users need mini program identity handling, OPENID/UNIONID access, or wx.cloud auth behavior in projects where login is native and automatic. Document name: cloud-functions - Document description: CloudBase function runtime guide for building, deploying, and debugging your own Event Functions or HTTP Functions. This skill should be used when users need application runtime code on CloudBase, not when they are merely calling CloudBase official platform APIs. Document name: cloud-storage-web - Document description: Complete guide for CloudBase cloud storage using Web SDK (@cloudbase/js-sdk) - upload, download, temporary URLs, file management, and best practices. Document name: cloudbase-agent - Document description: Build and deploy AI agents with CloudBase Agent SDK (TypeScript & Python). Implements the AG-UI protocol for streaming agent-UI communication. Use when deploying agent servers, using LangGraph/LangChain/CrewAI adapters, building custom adapters, understanding AG-UI protocol events, or building web/mini-program UI clients. Supports both TypeScript (@cloudbase/agent-server) and Python (cloudbase-agent-server via FastAPI). Document name: cloudbase-platform - Document description: CloudBase platform overview and routing guide. This skill should be used when users need high-level capability selection, platform concepts, console navigation, or cross-platform best practices before choosing a more specific implementation skill. Document name: cloudrun-development - Document description: 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 description: Optional advanced tool for complex data modeling. For simple table creation, use relational-database-tool directly with SQL statements. Document name: http-api - Document description: CloudBase official HTTP API client guide. This skill should be used when backends, scripts, or non-SDK clients must call CloudBase platform APIs over raw HTTP instead of using a platform SDK or MCP management tool. Document name: miniprogram-development - Document description: WeChat Mini Program development skill for building, debugging, previewing, testing, publishing, and optimizing mini program projects. This skill should be used when users ask to create, develop, modify, debug, preview, test, deploy, publish, launch, review, or optimize WeChat Mini Programs, mini program pages, components, routing, project structure, project configuration, project.config.json, appid setup, device preview, real-device validation, WeChat Developer Tools workflows, miniprogram-ci preview/upload flows, or mini program release processes. It should also be used when users explicitly mention CloudBase, wx.cloud, Tencent CloudBase, 腾讯云开发, or 云开发 in a mini program project. Document name: no-sql-web-sdk - Document description: Use CloudBase document database Web SDK to query, create, update, and delete data. Supports complex queries, pagination, aggregation, realtime, and geolocation queries. Document name: no-sql-wx-mp-sdk - Document description: Use CloudBase document database WeChat MiniProgram SDK to query, create, update, and delete data. Supports complex queries, pagination, aggregation, and geolocation queries. Document name: ops-inspector - Document description: AIOps-style one-click inspection skill for CloudBase resources. Use this skill when users need to diagnose errors, check resource health, inspect logs, or run a comprehensive health check across cloud functions, CloudRun services, databases, and other CloudBase resources. Document name: relational-database-tool - Document description: This is the required documentation for agents operating on the CloudBase Relational Database through MCP. It defines the canonical SQL management flow with querySqlDatabase, manageSqlDatabase, queryPermissions, and managePermissions, including MySQL provisioning, destroy flow, async status checks, safe query execution, schema initialization, and permission updates. Document name: relational-database-web - Document description: 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 description: Use when medium-to-large changes need explicit requirements, technical design, and task planning before implementation, especially for multi-module work, unclear acceptance criteria, or architecture-heavy requests. Document name: ui-design - Document description: Use when users need visual direction, interface hierarchy, layout decisions, design specifications, or prototypes before implementing a Web or mini program UI. Document name: web-development - Document description: Use when users need to implement, integrate, debug, build, deploy, or validate a Web frontend after the product direction is already clear, especially for React, Vue, Vite, browser flows, or CloudBase Web integration.

  OpenAPI documents (openapi) query currently supports 5 API documents, they are:
  API name: functions - API description: Cloud Functions API - Cloud Functions HTTP API

API name: storage - API description: Storage API - Cloud Storage HTTP API API name: mysqldb - API description: MySQL RESTful API - CloudBase MySQL Database HTTP API API name: auth - API description: Authentication API - Identity Authentication HTTP API API name: cloudrun - API description: CloudRun API - CloudRun Service HTTP API

Parameters

Parameter	Type	Required	Description
mode	string	Yes	Allowed values: "vector", "skill", "openapi", "docs"
skillName	string		Specify when mode=skill. Skill name. Allowed values: "skills", "ai-model-nodejs", "ai-model-web", "ai-model-wechat", "auth-nodejs", "auth-tool", "auth-web", "auth-wechat", "cloud-functions", "cloud-storage-web", "cloudbase-agent", "cloudbase-platform", "cloudrun-development", "data-model-creation", "http-api", "miniprogram-development", "no-sql-web-sdk", "no-sql-wx-mp-sdk", "ops-inspector", "relational-database-tool", "relational-database-web", "spec-workflow", "ui-design", "web-development"
apiName	string		Specify when mode=openapi. API name. Allowed values: "functions", "storage", "mysqldb", "auth", "cloudrun"
action	string		Specify when mode=docs. CloudBase documentation operation type: listModules=list all documentation modules, listModuleDocs=get directory structure of specified module, findByName=smart search by name/path/URL, readDoc=read specified documentation Markdown, searchDocs=full-text search official documentation. Allowed values: "listModules", "listModuleDocs", "findByName", "readDoc", "searchDocs"
moduleName	string		Specify when mode=docs and action=listModuleDocs. Module name.
input	string		Specify when mode=docs and action=findByName. Supports module name, document title, hierarchy path or URL.
docPath	string		Specify when mode=docs and action=readDoc. Document relative path or full URL.
query	string		Specify when mode=docs and action=searchDocs. Full-text search keywords.
threshold	number		Specify when mode=vector. Similarity retrieval threshold. Default: 0.5
id	string		Specify when mode=vector. Knowledge base scope, defaults to cloudbase. cloudbase=CloudBase full knowledge, scf=CloudBase cloud functions knowledge, miniprogram=Mini Program knowledge (excluding CloudBase and cloud functions knowledge). Allowed values: "cloudbase", "scf", "miniprogram"; Default: "cloudbase"
content	string		Specify when mode=vector. Retrieval content
options	object		Specify when mode=vector. Other options
options.chunkExpand	array of number		Specify the expansion length for returned document content, e.g., [3,3] means expand 3 before and 3 after. Default: [3,3]
limit	number		Specify when mode=vector. Specify the value of K for returning Top K most similar results. Default: 5

---

queryCloudRun

Query CloudRun 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.

Parameters

Parameter	Type	Required	Description
action	string	Yes	Query operation type: list=get CloudRun service list (supports pagination and filtering), detail=query detailed information of specified service (including configuration, version, access address, etc.), templates=get available project template list (for initializing new projects). Allowed values: "list", "detail", "templates"
pageSize	number		Page size, controls number of services returned per page. Range: 1-100, default: 10. Adjust based on network performance and display requirements. Default: 10
pageNum	number		Page number, for paginated queries. Starts from 1, default: 1. Use with pageSize for paginated browsing. Default: 1
serverName	string		Service name filter condition, supports fuzzy matching. E.g., entering "test" matches "test-service", "my-test-app", etc. Leave empty to query all services
serverType	string		Service type filter condition: function=function-type CloudRun (Node.js only, has special development requirements and limitations, suitable for simple API services), container=container-type service (recommended, supports any language and framework like Java/Go/Python/PHP/.NET, suitable for most application scenarios). Allowed values: "function", "container"
detailServerName	string		Service name to query detailed information for. Required when action is detail, must be an existing service name. Available service names can be obtained via list operation

---

manageCloudRun

Manage CloudRun 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.

Parameters

Parameter	Type	Required	Description
action	string	Yes	CloudRun service management operation type: init=initialize new CloudRun project code from template (creates subdirectory named serverName under targetPath, supports multiple language and framework templates), download=download existing service code from cloud to local for development, run=run function-type CloudRun service locally (for development and debugging, only supports function-type services), deploy=deploy local code to cloud CloudRun service (supports both function-type and container-type), delete=delete specified CloudRun service (irreversible, requires confirmation), createAgent=create function-type Agent (develop AI agents based on function-type CloudRun). Allowed values: "init", "download", "run", "deploy", "delete", "createAgent"
serverName	string	Yes	CloudRun service name, used to identify and manage services. Naming rules: supports uppercase/lowercase letters, numbers, hyphens and underscores, must start with letter, length 3-45 characters. In init operation used as subdirectory name created under targetPath, in other operations as target service name
targetPath	string		Local code path, must be absolute path. In deploy operation specifies code directory to deploy, in download operation specifies download target directory, in init operation specifies CloudRun service parent directory (will create subdirectory named serverName under this directory). Recommended convention: cloudrun/ directory under project root, e.g., /Users/username/projects/my-project/cloudrun
serverConfig	object		Service configuration items, used to set service runtime parameters during deployment. Includes resource specs, access permissions, environment variables and other configuration. Uses default configuration if not provided
serverConfig.OpenAccessTypes	array of string		Public network access type configuration, controls service access permissions: OA=office network access, PUBLIC=public network access (default, accessible via HTTPS domain), MINIAPP=mini program access, VPC=VPC access (only accessible within same VPC). Can configure multiple types
serverConfig.Cpu	number		CPU spec configuration, unit is cores. Options: 0.25, 0.5, 1, 2, 4, 8, etc. Note: Memory spec must be 2x CPU spec (e.g., CPU=0.25 then memory=0.5, CPU=1 then memory=2). Affects service performance and billing
serverConfig.Mem	number		Memory spec configuration, unit is GB. Options: 0.5, 1, 2, 4, 8, 16, etc. Note: Must be 2x CPU spec. Affects service performance and billing
serverConfig.MinNum	number		Minimum instance count configuration, controls minimum number of running service instances. Setting to 0 enables scale-to-zero (no cost when no requests), setting > 0 always keeps specified number of instances running (ensures fast response but increases cost). Recommended to set to 1 to reduce cold start latency and improve user experience
serverConfig.MaxNum	number		Maximum instance count configuration, controls maximum number of running service instances. When request volume increases, service can scale up to specified number of instances, beyond which new requests will be rejected. Recommended to set based on business peak
serverConfig.PolicyDetails	array of object		Scaling configuration array, used to configure service auto-scaling policies. Can configure multiple scaling policies
serverConfig.PolicyDetails[].PolicyType	string	Yes	Scaling type: cpu=CPU utilization-based scaling, mem=memory utilization-based scaling, cpu/mem=CPU and memory utilization-based scaling. Allowed values: "cpu", "mem", "cpu/mem"
serverConfig.PolicyDetails[].PolicyThreshold	number	Yes	Scaling threshold, unit is percentage. E.g., 60 means trigger scaling when resource utilization reaches 60%
serverConfig.CustomLogs	string		Custom log configuration, used to configure service log collection and storage policies
serverConfig.Port	number		Service listening port configuration. Function-type services fixed at 3000, container-type services can be customized. Service code must listen on this port to receive requests normally
serverConfig.EnvParams	string		Environment variable configuration, JSON string format. Used to pass configuration information to service code, e.g., '{"DATABASE_URL":"mysql://...","NODE_ENV":"production"}'. Sensitive information is recommended to use environment variables rather than hardcoding
serverConfig.Dockerfile	string		Dockerfile filename configuration, only required for container-type services. Specifies the Dockerfile file path for building container images, defaults to Dockerfile in project root
serverConfig.BuildDir	string		Build directory configuration, specifies the directory path for code building. Used when code structure differs from standard, defaults to project root
serverConfig.InternalAccess	string		Internal network access switch configuration, controls whether to enable internal network access. true=enable internal network access (can be called directly via CloudBase SDK), false=disable internal network access (public network access only)
serverConfig.InternalDomain	string		Internal network domain configuration, used to configure service internal network access domain. Only effective when internal network access is enabled
serverConfig.EntryPoint	array of string		Dockerfile EntryPoint parameter configuration, only required for container-type services. Specifies entry program array when container starts, e.g., ["node","app.js"]
serverConfig.Cmd	array of string		Dockerfile Cmd parameter configuration, only required for container-type services. Specifies default command array when container starts, e.g., ["npm","start"]
template	string		Project template identifier, used to specify template for project initialization. Available template list can be obtained via queryCloudRun templates operation. Common templates: helloworld=Hello World example, nodejs=Node.js project template, python=Python project template, etc. Default: "helloworld"
runOptions	object		Local run parameter configuration, only supports function-type CloudRun services. Used to configure local development environment run parameters, does not affect cloud deployment
runOptions.port	number		Local run port configuration, only effective for function-type services. Specifies the port number for service to listen on locally, default 3000. Ensure port is not occupied by other programs. Default: 3000
runOptions.envParams	object		Additional environment variable configuration for local run, used for local development and debugging. Format is key-value pairs, e.g., {"DEBUG":"true","LOG_LEVEL":"debug"}. These variables only take effect when running locally
runOptions.runMode	string		Run mode: normal=normal function mode, agent=Agent mode (for AI agent development). Allowed values: "normal", "agent"; Default: "normal"
runOptions.agentId	string		Agent ID, used in agent mode to identify specific Agent instance
agentConfig	object		Agent configuration items, only used in createAgent operation
agentConfig.agentName	string	Yes	Agent name, used to generate BotId
agentConfig.botTag	string		Bot tag, used to generate BotId, auto-generated if not provided
agentConfig.description	string		Agent description information
agentConfig.template	string		Agent template type, defaults to blank (blank template). Default: "blank"
force	boolean		Force operation switch, used to skip confirmation prompts. Defaults to false (requires confirmation), set to true to skip all confirmation steps. Strongly recommended to set to true for delete operations to avoid accidental operations. Default: false
serverType	string		Service type configuration: function=function-type CloudRun (Node.js only, has special development requirements and limitations, suitable for simple API services), container=container-type service (recommended, supports any language and framework like Java/Go/Python/PHP/.NET, suitable for most application scenarios). Auto-detected if not provided: 1) existing service type 2) has Dockerfile→container 3) has @cloudbase/aiagent-framework dependency→function 4) otherwise→container. Allowed values: "function", "container"

---

queryGateway

Unified read-only entry for the gateway domain. Query gateway domains, access entries, and target exposure status via action.

Parameters

Parameter	Type	Required	Description
action	string	Yes	Read-only operation type, e.g., getAccess, listDomains. Allowed values: "getAccess", "listDomains", "listRoutes", "getRoute", "listCustomDomains"
targetType	string		Target resource type. Currently supports function, extensible in future. Allowed values: "function"
targetName	string		Target resource name. Required for getAccess
routeId	string		Route ID. Optional for getRoute

---

manageGateway

Unified write entry for the gateway domain. Create target access entries via action, with more general gateway configuration capabilities to follow.

Parameters

Parameter	Type	Required	Description
action	string	Yes	Write operation type, e.g., createAccess. Allowed values: "createAccess", "createRoute", "updateRoute", "deleteRoute", "bindCustomDomain", "deleteCustomDomain", "deleteAccess", "updatePathAuth"
targetType	string		Target resource type. Currently supports function, extensible in future. Allowed values: "function"
targetName	string		Target resource name
path	string		Access path, defaults to /{targetName}
type	string		Target function's own type (not access form). If the accessed function is Event type (default), pass Event here; only pass HTTP when the accessed function was created as HTTP function. Allowed values: "Event", "HTTP"
auth	boolean		Whether to enable authentication
route	object		HTTP route configuration object
route.routeId	string
route.path	string
route.serviceType	string
route.serviceName	string
route.auth	boolean
domain	string		Custom domain
certificateId	string		Certificate ID
accessName	string		Access entry name, reserved field

---

queryAppAuth

Read-only entry for application-side authentication configuration. Used to query login methods, providers, publishable key, API key, client configuration, and static domain authentication readiness status. If the business needs to accept plain username-style identifiers, first query action=getLoginConfig; if usernamePassword=false, the next step should immediately call manageAppAuth(action=patchLoginStrategy, patch={ usernamePassword: true }), do not directly write email login API.

Parameters

Parameter	Type	Required	Description
action	string	Yes	Allowed values: "getLoginConfig", "listProviders", "getProvider", "getClientConfig", "getPublishableKey", "getStaticDomain", "listApiKeys"
providerId	string		Provider identifier, e.g., email, google
clientId	string		OAuth client_id / DescribeClient Id; uses current environment ID (default client) when omitted
keyType	string		API key type filter, optional publish_key or api_key. Allowed values: "publish_key", "api_key"
pageNumber	integer		API key list page number, starts from 1
pageSize	integer		API key list items per page

---

manageAppAuth

Write entry for application-side authentication configuration. Used to modify login methods, providers, client configuration, ensure publishable key, and create or delete API keys and custom login keys. If the frontend needs to accept plain username-style identifiers, first execute action=patchLoginStrategy with patch={ usernamePassword: true }, then implement the corresponding frontend login logic.

Parameters

Parameter	Type	Required	Description
action	string	Yes	Allowed values: "patchLoginStrategy", "addProvider", "updateProvider", "deleteProvider", "updateClientConfig", "ensurePublishableKey", "createApiKey", "deleteApiKey", "createCustomLoginKeys"
patch	object		Simplified login strategy patch used by patchLoginStrategy, e.g., { usernamePassword: true }
providerId	string		Provider identifier, e.g., email, google; for addProvider can also be used as custom provider Id
providerType	string		Provider protocol type for addProvider, e.g., OAUTH, OIDC, EMAIL
displayName	string | object		Display name for addProvider, can pass string or multilingual object
clientId	string		Client Id for updateClientConfig; uses current environment ID when omitted
config	object		Provider / client configuration object
keyType	string		API key type for createApiKey, defaults to publish_key. Allowed values: "publish_key", "api_key"
keyName	string		API key name for createApiKey
expireIn	integer		Validity period for createApiKey, unit is seconds; 0 means no expiration
keyId	string		API key unique identifier for deleteApiKey

---

queryPermissions

Unified read-only entry for the permissions domain. Supports querying resource permissions, role list/details, and application user list/details.

Parameters

Parameter	Type	Required	Description
action	string	Yes	Allowed values: "getResourcePermission", "listResourcePermissions", "listRoles", "getRole", "listUsers", "getUser"
resourceType	string		Allowed values: "noSqlDatabase", "sqlDatabase", "function", "storage"
resourceId	string
resourceIds	array of string
roleId	string
roleIdentity	string
roleName	string
uid	string
username	string
pageNo	number
pageSize	number

---

managePermissions

Unified write entry for the permissions domain. Supports modifying resource permissions, role management, member and policy add/remove, and application user CRUD. createUser / updateUser are environment-side application user management capabilities, suitable for test accounts, administrators, or preset users, and should not replace browser-side Web SDK registration forms; frontend username password registration should use auth.signUp({ username, password }), login should use auth.signInWithPassword({ username, password }). Note: The detailed semantics of securityRule depend on resourceType; doc._openid, auth.openid, query condition subset validation, and create / update / delete JSON templates only apply to resourceType="noSqlDatabase" document database security rules. When configuring function or storage, please refer to their respective official security rule documentation, not reuse NoSQL templates.

Parameters

Parameter	Type	Required	Description
action	string	Yes	Allowed values: "updateResourcePermission", "createRole", "updateRole", "deleteRoles", "addRoleMembers", "removeRoleMembers", "addRolePolicies", "removeRolePolicies", "createUser", "updateUser", "deleteUsers"
resourceType	string		Target resource type. The specific semantics of `securityRule` depend on this value; `noSqlDatabase` uses collection security rules, `function` and `storage` also have their own independent security rule semantics, do not apply NoSQL rule syntax. Allowed values: "noSqlDatabase", "sqlDatabase", "function", "storage"
resourceId	string
permission	string		Allowed values: "READONLY", "PRIVATE", "ADMINWRITE", "ADMINONLY", "CUSTOM"
securityRule	string		Resource type-specific rule content, detailed semantics depend on resourceType. When resourceType="noSqlDatabase" and permission="CUSTOM", should pass document database security rule JSON (document database rules: https://docs.cloudbase.net/database/security-rules); keys are typically read / create / update / delete, values are expressions. Important: create rule validates written data, document doesn't exist yet at this point, cannot use doc.*; read / update / delete rules can use doc.* to reference existing document fields. Do not misuse doc._openid, auth.openid, query condition subset validation or create / update / delete templates for function, storage or sqlDatabase. For configuring function or storage, please refer to official security rule documentation: cloud functions https://docs.cloudbase.net/cloud-function/security-rules, cloud storage https://docs.cloudbase.net/storage/security-rules. Example: {"read":"auth.uid != null","create":"auth.uid != null && auth.loginType != \"ANONYMOUS\"","update":"auth.uid != null && doc._openid == auth.openid","delete":"auth.uid != null && doc._openid == auth.openid"}
roleId	string
roleIds	array of string
roleName	string
roleIdentity	string
description	string
memberUids	array of string
policies	array of object
uid	string
uids	array of string
username	string
password	string
userStatus	string		Allowed values: "ACTIVE", "BLOCKED"

---

queryLogs

Unified read-only entry for the logs domain. Supports checking log service status and searching CLS logs.

Parameters

Parameter	Type	Required	Description
action	string	Yes	Allowed values: "checkLogService", "searchLogs"
queryString	string
service	string		Allowed values: "tcb", "tcbr"
startTime	string
endTime	string
limit	number
context	string
sort	string		Allowed values: "asc", "desc"

---

queryAgents

Unified read-only entry for the Agent domain. Supports listing, details, and log queries.

Parameters

Parameter	Type	Required	Description
action	string	Yes	Allowed values: "listAgents", "getAgent", "getAgentLogs"
agentId	string
pageNumber	number
pageSize	number
params	object

---

manageAgents

Unified write entry for the Agent domain. Supports creating, updating, and deleting remote Agents.

Parameters

Parameter	Type	Required	Description
action	string	Yes	Allowed values: "createAgent", "updateAgent", "deleteAgent"
agentId	string
params	object

---

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.

Parameters

Parameter	Type	Required	Description
url	string	Yes	Remote file URL address
relativePath	string	Yes	Path relative to project root directory, e.g., 'assets/images/logo.png' or 'docs/api.md'. Path traversal operations like ../ are not allowed.

---

activateInviteCode

CloudBase AI programming incentive program, activate user incentives through invite code.

Parameters

Parameter	Type	Required	Description
InviteCode	string	Yes	Invite code to activate

---

callCloudApi

General cloud API calling tool, mainly used for CloudBase / Tencent Cloud management plane and dependent resource related API calls. Before calling, please confirm service, Action and Param first, avoid guessing Action names. If your goal is to directly integrate auth/functions/cloudrun/storage/mysqldb and other CloudBase business APIs via HTTP protocol, do not prioritize using callCloudApi, instead prioritize checking the corresponding OpenAPI / Swagger. The existing OpenAPI / Swagger capabilities are not a general management plane Action collection; for management plane APIs, please prioritize referring to CloudBase API Overview https://cloud.tencent.com/document/product/876/34809 and CloudBase Dependent Resource API Guide https://cloud.tencent.com/document/product/876/34808. For tcb service, common Action categories are as follows:

Environment Management: CreateEnv, ModifyEnv, DescribeEnvs, DestroyEnv User Management: CreateUser, ModifyUser, DescribeUserList, DeleteUsers Authentication Configuration: EditAuthConfig, DescribeAuthDomains Cloud Functions: DescribeFunctions, CreateFunction, UpdateFunctionCode, DeleteFunction Database: CreateMySQLInstance, DescribeMySQLInstances, DestroyMySQLInstance

When destroying an environment, the common practice is to at least include EnvId and BypassCheck: true; if the environment is already in isolation period, add IsForce: true per documentation.

Parameters

Parameter	Type	Required	Description
service	string	Yes	Select the service to access. Options: tcb, scf, sts, cam, lowcode, cdn, vpc. For tcb / scf / lowcode and other CloudBase management plane Actions, please prioritize checking official documentation, do not guess Actions directly. Allowed values: "tcb", "scf", "sts", "cam", "lowcode", "cdn", "vpc"
action	string	Yes	Specific Action name, must conform to the corresponding service's official API definition. If unsure about correct Action, please check official documentation first; do not guess using synonyms or historical names. tcb common Actions: Environment Management CreateEnv/ModifyEnv/DescribeEnvs/DestroyEnv, User Management CreateUser/ModifyUser/DescribeUserList/DeleteUsers, Authentication Configuration EditAuthConfig, Cloud Functions DescribeFunctions/CreateFunction, Database CreateMySQLInstance, etc.
params	object		Parameter object corresponding to the Action, key names must match official API definition. Some Actions require EnvId and other information; if unsure about parameter structure, please check official documentation first. tcb example: { "service": "tcb", "action": "DestroyEnv", "params": { "EnvId": "env-xxx", "BypassCheck": true } }, if environment is already in isolation period, can add IsForce: true; to update environment alias use { "service": "tcb", "action": "ModifyEnv", "params": { "EnvId": "env-xxx", "Alias": "demo" } }. If your scenario is to directly integrate auth/functions/cloudrun/storage/mysqldb and other CloudBase business APIs via HTTP protocol, please prioritize using OpenAPI / Swagger or searchKnowledgeBase(mode="openapi"), not prioritize using callCloudApi.

---