跳到主要内容

MCP 工具

当前包含 38 个工具。

源数据: tools.json


工具总览

名称描述
login登录云开发环境,在生成包含云开发 CloudBase 相关功能前**必须**先调用此工具进行登录。登录云开发环境并选择要使用的环境。
logout退出云开发环境
envQuery查询云开发环境相关信息,支持查询环境列表、当前环境信息、安全域名和静态网站托管配置。(原工具名:listEnvs/getEnvInfo/getEnvAuthDomains/getWebsiteConfig,为兼容旧AI规则可继续使用这些名称)
envDomainManagement管理云开发环境的安全域名,支持添加和删除操作。(原工具名:createEnvDomain/deleteEnvDomain,为兼容旧AI规则可继续使用这些名称)
readNoSqlDatabaseStructure读取 NoSQL 数据库结构
writeNoSqlDatabaseStructure修改 NoSQL 数据库结构
readNoSqlDatabaseContent查询并获取 NoSQL 数据库数据记录
writeNoSqlDatabaseContent修改 NoSQL 数据库数据记录
executeReadOnlySQLExecute 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.
executeWriteSQLExecute 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数据模型查询工具,支持查询和列表数据模型(只读操作)。list操作返回基础信息(不含Schema),get操作返回详细信息(含简化的Schema,包括字段列表、格式、关联关系等),docs操作生成SDK使用文档
modifyDataModel基于Mermaid classDiagram创建或更新数据模型。支持创建新模型和更新现有模型结构。内置异步任务监控,自动轮询直至完成或超时。
getFunctionList获取云函数列表或单个函数详情,通过 action 参数区分操作类型
createFunction创建云函数
updateFunctionCode更新已存在函数的代码。注意:此工具仅用于更新代码,不支持修改函数配置(如 runtime)。如果需要修改 runtime,需要删除函数后使用 createFunction 重新创建。
updateFunctionConfig更新云函数配置
invokeFunction调用云函数
getFunctionLogs获取云函数日志基础信息(LogList),如需日志详情请用 RequestId 调用 getFunctionLogDetail 工具。此接口基于 manger-node 4.4.0+ 的 getFunctionLogsV2 实现,不返回具体日志内容。参数 offset+limit 不得大于 10000,startTime/endTime 间隔不得超过一天。
getFunctionLogDetail根据 getFunctionLogs 返回的 RequestId 查询日志详情。参数 startTime、endTime、requestId,返回日志内容(LogJson 等)。仅支持 manger-node 4.4.0+。
manageFunctionTriggers创建或删除云函数触发器,通过 action 参数区分操作类型
uploadFiles上传文件到静态网站托管
deleteFiles删除静态网站托管的文件或文件夹
findFiles搜索静态网站托管的文件
domainManagement统一的域名管理工具,支持绑定、解绑、查询和修改域名配置
queryStorage查询云存储信息,支持列出目录文件、获取文件信息、获取临时下载链接等只读操作。返回的文件信息包括文件名、大小、修改时间、下载链接等。
manageStorage管理云存储文件,支持上传文件/目录、下载文件/目录、删除文件/目录等操作。删除操作需要设置force=true进行确认,防止误删除重要文件。
downloadTemplate自动下载并部署CloudBase项目模板。⚠️ **MANDATORY FOR NEW PROJECTS** ⚠️<br/>**CRITICAL**: This tool MUST be called FIRST when starting a new project.<br/>支持的模板:<br/>- react: React + CloudBase 全栈应用模板<br/>- vue: Vue + CloudBase 全栈应用模板<br/>- miniprogram: 微信小程序 + 云开发模板 <br/>- uniapp: UniApp + CloudBase 跨端应用模板<br/>- rules: 只包含AI编辑器配置文件(包含Cursor、WindSurf、CodeBuddy等所有主流编辑器配置),适合在已有项目中补充AI编辑器配置<br/>支持的IDE类型:<br/>- all: 下载所有IDE配置(默认)<br/>- cursor: Cursor AI编辑器<br/>- windsurf: WindSurf AI编辑器<br/>- codebuddy: CodeBuddy AI编辑器<br/>- claude-code: Claude Code AI编辑器<br/>- cline: Cline AI编辑器<br/>- gemini-cli: Gemini CLI<br/>- opencode: OpenCode AI编辑器<br/>- qwen-code: 通义灵码<br/>- baidu-comate: 百度Comate<br/>- openai-codex-cli: OpenAI Codex CLI<br/>- augment-code: Augment Code<br/>- github-copilot: GitHub Copilot<br/>- roocode: RooCode AI编辑器<br/>- tongyi-lingma: 通义灵码<br/>- trae: Trae AI编辑器<br/>- qoder: Qoder AI编辑器<br/>- antigravity: Google Antigravity AI编辑器<br/>- vscode: Visual Studio Code<br/>特别说明:<br/>- rules 模板会自动包含当前 mcp 版本号信息(版本号:2.5.0),便于后续维护和版本追踪<br/>- 下载 rules 模板时,如果项目中已存在 README.md 文件,系统会自动保护该文件不被覆盖(除非设置 overwrite=true)
interactiveDialog统一的交互式对话工具,支持需求澄清和任务确认,当需要和用户确认下一步的操作的时候,可以调用这个工具的clarify,如果有敏感的操作,需要用户确认,可以调用这个工具的confirm
searchWeb使用联网来进行信息检索,如查询最新的新闻、文章、股价、天气等。支持自然语言查询,也可以直接输入网址获取网页内容
searchKnowledgeBase云开发知识库智能检索工具,支持向量查询 (vector)、固定文档 (doc) 和 OpenAPI 文档 (openapi) 查询。<br/> 强烈推荐始终优先使用固定文档 (doc) 或 OpenAPI 文档 (openapi) 模式进行检索,仅当固定文档无法覆盖你的问题时,再使用向量查询 (vector) 模式。<br/> 固定文档 (doc) 查询当前支持 16 个固定文档,分别是:<br/> 文档名:auth-http-api 文档介绍: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.<br/>文档名:auth-nodejs 文档介绍:Complete guide for CloudBase Auth using the CloudBase Node SDK – caller identity, user lookup, custom login tickets, and server-side best practices.<br/>文档名:auth-web 文档介绍: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.<br/>文档名:auth-wechat 文档介绍:Complete guide for WeChat Mini Program authentication with CloudBase - native login, user identity, and cloud function integration.<br/>文档名:cloudbase-platform 文档介绍: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.<br/>文档名:cloudrun-development 文档介绍: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.<br/>文档名:data-model-creation 文档介绍:Optional advanced tool for complex data modeling. For simple table creation, use relational-database-tool directly with SQL statements.<br/>文档名:http-api 文档介绍: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.<br/>文档名:miniprogram-development 文档介绍:WeChat Mini Program development rules. Use this skill when developing WeChat mini programs, integrating CloudBase capabilities, and deploying mini program projects.<br/>文档名:no-sql-web-sdk 文档介绍:Use CloudBase document database Web SDK to query, create, update, and delete data. Supports complex queries, pagination, aggregation, and geolocation queries.<br/>文档名:no-sql-wx-mp-sdk 文档介绍:Use CloudBase document database WeChat MiniProgram SDK to query, create, update, and delete data. Supports complex queries, pagination, aggregation, and geolocation queries.<br/>文档名:relational-database-tool 文档介绍: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.<br/>文档名:relational-database-web 文档介绍: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.<br/>文档名:spec-workflow 文档介绍: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.<br/>文档名:ui-design 文档介绍: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.<br/>文档名:web-development 文档介绍:Web frontend project development rules. Use this skill when developing web frontend pages, deploying static hosting, and integrating CloudBase Web SDK.<br/> OpenAPI 文档 (openapi) 查询当前支持 5 个 API 文档,分别是:<br/> API名:mysqldb API介绍:MySQL RESTful API - 云开发 MySQL 数据库 HTTP API<br/>API名:functions API介绍:Cloud Functions API - 云函数 HTTP API<br/>API名:auth API介绍:Authentication API - 身份认证 HTTP API<br/>API名:cloudrun API介绍:CloudRun API - 云托管服务 HTTP API<br/>API名:storage API介绍:Storage API - 云存储 HTTP API
queryCloudRun查询云托管服务信息,支持获取服务列表、查询服务详情和获取可用模板列表。返回的服务信息包括服务名称、状态、访问类型、配置详情等。
manageCloudRun管理云托管服务,按开发顺序支持:初始化项目(可从模板开始,模板列表可通过 queryCloudRun 查询)、下载服务代码、本地运行(仅函数型服务)、部署代码、删除服务。部署可配置CPU、内存、实例数、访问类型等参数。删除操作需要确认,建议设置force=true。
createFunctionHTTPAccess创建云函数的 HTTP 访问
downloadRemoteFile下载远程文件到项目根目录下的指定相对路径。例如:小程序的 Tabbar 等素材图片,必须使用 **png** 格式,可以从 Unsplash、wikimedia【一般选用 500 大小即可、Pexels、Apple 官方 UI 等资源中选择来下载。
readSecurityRule读取指定资源(noSQL 数据库、SQL 数据库、云函数、存储桶)的安全规则和权限类别。
writeSecurityRule设置指定资源(数据库集合、云函数、存储桶)的安全规则。
activateInviteCode云开发 AI编程激励计划,通过邀请码激活用户激励。
callCloudApi通用的云 API 调用工具,使用前请务必先阅读相关rules或skills,确认所需服务、Action 与 Param 的正确性和安全性

云端 MCP 配置说明

环境变量配置

使用云端 MCP 需要配置以下环境变量:

环境变量说明获取方式
TENCENTCLOUD_SECRETID腾讯云 SecretId获取腾讯云 API 密钥
TENCENTCLOUD_SECRETKEY腾讯云 SecretKey获取腾讯云 API 密钥
TENCENTCLOUD_SESSIONTOKEN非必填,腾讯云临时密钥 Token(可选)仅在使用临时密钥时需要,可通过 STS 服务 获取
CLOUDBASE_ENV_ID云开发环境 ID获取云开发环境 ID

详细规格

login

登录云开发环境,在生成包含云开发 CloudBase 相关功能前必须先调用此工具进行登录。登录云开发环境并选择要使用的环境。

参数

参数名类型必填说明
forceUpdateboolean是否强制重新选择环境

logout

退出云开发环境

参数

参数名类型必填说明
confirmstring确认操作,默认传 yes 可填写的值: const "yes"

envQuery

查询云开发环境相关信息,支持查询环境列表、当前环境信息、安全域名和静态网站托管配置。(原工具名:listEnvs/getEnvInfo/getEnvAuthDomains/getWebsiteConfig,为兼容旧AI规则可继续使用这些名称)

参数

参数名类型必填说明
actionstring查询类型:list=环境列表,info=当前环境信息,domains=安全域名列表,hosting=静态网站托管配置 可填写的值: "list", "info", "domains", "hosting"

envDomainManagement

管理云开发环境的安全域名,支持添加和删除操作。(原工具名:createEnvDomain/deleteEnvDomain,为兼容旧AI规则可继续使用这些名称)

参数

参数名类型必填说明
actionstring操作类型:create=添加域名,delete=删除域名 可填写的值: "create", "delete"
domainsarray of string安全域名数组

readNoSqlDatabaseStructure

读取 NoSQL 数据库结构

参数

参数名类型必填说明
actionstringlistCollections: 列出集合列表<br/>describeCollection: 描述集合<br/>checkCollection: 检查集合是否存在<br/>listIndexes: 列出索引列表<br/>checkIndex: 检查索引是否存在 可填写的值: "listCollections", "describeCollection", "checkCollection", "listIndexes", "checkIndex"
limitnumber返回数量限制(listCollections 操作时可选)
offsetnumber偏移量(listCollections 操作时可选)
collectionNamestring集合名称(describeCollection、listIndexes、checkIndex 操作时必填)
indexNamestring索引名称(checkIndex 操作时必填)

writeNoSqlDatabaseStructure

修改 NoSQL 数据库结构

参数

参数名类型必填说明
actionstringcreateCollection: 创建集合<br/>updateCollection: 更新集合 可填写的值: "createCollection", "updateCollection"
collectionNamestring集合名称
updateOptionsobject更新选项(updateCollection 时使用)
updateOptions.CreateIndexesarray of object
updateOptions.CreateIndexes[].IndexNamestring
updateOptions.CreateIndexes[].MgoKeySchemaobject
updateOptions.CreateIndexes[].MgoKeySchema.MgoIsUniqueboolean
updateOptions.CreateIndexes[].MgoKeySchema.MgoIndexKeysarray of object
updateOptions.CreateIndexes[].MgoKeySchema.MgoIndexKeys[].Namestring
updateOptions.CreateIndexes[].MgoKeySchema.MgoIndexKeys[].Directionstring
updateOptions.DropIndexesarray of object
updateOptions.DropIndexes[].IndexNamestring

readNoSqlDatabaseContent

查询并获取 NoSQL 数据库数据记录

参数

参数名类型必填说明
collectionNamestring集合名称
queryobject \| string查询条件(对象或字符串,推荐对象)
projectionobject \| string返回字段投影(对象或字符串,推荐对象)
sortobject \| string排序条件(对象或字符串,推荐对象)
limitnumber返回数量限制
offsetnumber跳过的记录数

writeNoSqlDatabaseContent

修改 NoSQL 数据库数据记录

参数

参数名类型必填说明
actionstringcreateCollection: 创建数据<br/>updateCollection: 更新数据<br/>deleteCollection: 删除数据 可填写的值: "insert", "update", "delete"
collectionNamestring集合名称
documentsarray of object要插入的文档对象数组,每个文档都是对象(insert 操作必填)
queryobject \| string查询条件(对象或字符串,推荐对象)(update/delete 操作必填)
updateobject \| string更新内容(对象或字符串,推荐对象)(update 操作必填)
isMultiboolean是否更新多条记录(update/delete 操作可选)
upsertboolean是否在不存在时插入(update 操作可选)

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.

参数

参数名类型必填说明
sqlstringSQL query statement (SELECT queries only)

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.

参数

参数名类型必填说明
sqlstringSQL statement (INSERT, UPDATE, DELETE, CREATE, ALTER, etc.)

manageDataModel

数据模型查询工具,支持查询和列表数据模型(只读操作)。list操作返回基础信息(不含Schema),get操作返回详细信息(含简化的Schema,包括字段列表、格式、关联关系等),docs操作生成SDK使用文档

参数

参数名类型必填说明
actionstring操作类型:get=查询单个模型(含Schema字段列表、格式、关联关系),list=获取模型列表(不含Schema),docs=生成SDK使用文档 可填写的值: "get", "list", "docs"
namestring模型名称(get操作时必填)
namesarray of string模型名称数组(list操作时可选,用于过滤)

modifyDataModel

基于Mermaid classDiagram创建或更新数据模型。支持创建新模型和更新现有模型结构。内置异步任务监控,自动轮询直至完成或超时。

参数

参数名类型必填说明
mermaidDiagramstringMermaid classDiagram代码,描述数据模型结构。
actionstring操作类型:create=创建新模型 可填写的值: "create", "update";默认值: "create"
publishboolean是否立即发布模型 默认值: false
dbInstanceTypestring数据库实例类型 默认值: "MYSQL"
示例
classDiagram
class Student {
name: string <<姓名>>
age: number = 18 <<年龄>>
gender: x-enum = "男" <<性别>>
classId: string <<班级ID>>
identityId: string <<身份ID>>
course: Course[] <<课程>>
required() ["name"]
unique() ["name"]
enum_gender() ["男", "女"]
display_field() "name"
}
class Class {
className: string <<班级名称>>
display_field() "className"
}
class Course {
name: string <<课程名称>>
students: Student[] <<学生>>
display_field() "name"
}
class Identity {
number: string <<证件号码>>
display_field() "number"
}

%% 关联关系
Student "1" --> "1" Identity : studentId
Student "n" --> "1" Class : student2class
Student "n" --> "m" Course : course
Student "n" <-- "m" Course : students
%% 类的命名
note for Student "学生模型"
note for Class "班级模型"
note for Course "课程模型"
note for Identity "身份模型"

getFunctionList

获取云函数列表或单个函数详情,通过 action 参数区分操作类型

参数

参数名类型必填说明
actionstring操作类型:list=获取函数列表(默认),detail=获取函数详情 可填写的值: "list", "detail"
limitnumber范围(list 操作时使用)
offsetnumber偏移(list 操作时使用)
namestring函数名称(detail 操作时必需)
codeSecretstring代码保护密钥(detail 操作时使用)

createFunction

创建云函数

参数

参数名类型必填说明
funcobject函数配置
func.namestring函数名称
func.timeoutnumber函数超时时间
func.envVariablesobject环境变量
func.vpcobject私有网络配置
func.vpc.vpcIdstring
func.vpc.subnetIdstring
func.runtimestring运行时环境,建议指定为 'Nodejs18.15',其他可选值:Nodejs18.15,Nodejs16.13,Nodejs14.18,Nodejs12.16,Nodejs10.15,Nodejs8.9
func.triggersarray of objectTrigger configuration array
func.triggers[].namestringTrigger name
func.triggers[].typestringTrigger type, currently only supports 'timer' 可填写的值: "timer"
func.triggers[].configstringTrigger configuration. For timer triggers, use cron expression format: second minute hour day month week year. IMPORTANT: Must include exactly 7 fields (second minute hour day month week year). Examples: '0 0 2 1 * * *' (monthly), '0 30 9 * * * *' (daily at 9:30 AM)
func.handlerstring函数入口
func.ignorestring \| array of string忽略文件
func.isWaitInstallboolean是否等待依赖安装
func.layersarray of objectLayer配置
func.layers[].namestring
func.layers[].versionnumber
functionRootPathstring函数根目录(云函数目录的父目录),这里需要传操作系统上文件的绝对路径,注意:不要包含函数名本身,例如函数名为 'hello',应传入 '/path/to/cloudfunctions',而不是 '/path/to/cloudfunctions/hello'
forceboolean是否覆盖

updateFunctionCode

更新已存在函数的代码。注意:此工具仅用于更新代码,不支持修改函数配置(如 runtime)。如果需要修改 runtime,需要删除函数后使用 createFunction 重新创建。

参数

参数名类型必填说明
namestring函数名称
functionRootPathstring函数根目录(云函数目录的父目录),这里需要传操作系统上文件的绝对路径

updateFunctionConfig

更新云函数配置

参数

参数名类型必填说明
funcParamobject函数配置
funcParam.namestring函数名称
funcParam.timeoutnumber超时时间
funcParam.envVariablesobject环境变量
funcParam.vpcobjectVPC配置
funcParam.vpc.vpcIdstring
funcParam.vpc.subnetIdstring

invokeFunction

调用云函数

参数

参数名类型必填说明
namestring函数名称
paramsobject调用参数

getFunctionLogs

获取云函数日志基础信息(LogList),如需日志详情请用 RequestId 调用 getFunctionLogDetail 工具。此接口基于 manger-node 4.4.0+ 的 getFunctionLogsV2 实现,不返回具体日志内容。参数 offset+limit 不得大于 10000,startTime/endTime 间隔不得超过一天。

参数

参数名类型必填说明
namestring函数名称
offsetnumber数据的偏移量,Offset+Limit 不能大于 10000
limitnumber返回数据的长度,Offset+Limit 不能大于 10000
startTimestring查询的具体日期,例如:2017-05-16 20:00:00,只能与 EndTime 相差一天之内
endTimestring查询的具体日期,例如:2017-05-16 20:59:59,只能与 StartTime 相差一天之内
requestIdstring执行该函数对应的 requestId
qualifierstring函数版本,默认为 $LATEST

getFunctionLogDetail

根据 getFunctionLogs 返回的 RequestId 查询日志详情。参数 startTime、endTime、requestId,返回日志内容(LogJson 等)。仅支持 manger-node 4.4.0+。

参数

参数名类型必填说明
startTimestring查询的具体日期,例如:2017-05-16 20:00:00,只能与 EndTime 相差一天之内
endTimestring查询的具体日期,例如:2017-05-16 20:59:59,只能与 StartTime 相差一天之内
requestIdstring执行该函数对应的 requestId

manageFunctionTriggers

创建或删除云函数触发器,通过 action 参数区分操作类型

参数

参数名类型必填说明
actionstring操作类型:create=创建触发器,delete=删除触发器 可填写的值: "create", "delete"
namestring函数名
triggersarray of object触发器配置数组(创建时必需)
triggers[].namestringTrigger name
triggers[].typestringTrigger type, currently only supports 'timer' 可填写的值: "timer"
triggers[].configstringTrigger configuration. For timer triggers, use cron expression format: second minute hour day month week year. IMPORTANT: Must include exactly 7 fields (second minute hour day month week year). Examples: '0 0 2 1 * * *' (monthly), '0 30 9 * * * *' (daily at 9:30 AM)
triggerNamestring触发器名称(删除时必需)

uploadFiles

上传文件到静态网站托管

参数

参数名类型必填说明
localPathstring本地文件或文件夹路径,需要是绝对路径,例如 /tmp/files/data.txt
cloudPathstring云端文件或文件夹路径,例如files/data.txt
filesarray of object多文件上传配置 默认值: []
files[].localPathstring
files[].cloudPathstring
ignorestring \| array of string忽略文件模式

deleteFiles

删除静态网站托管的文件或文件夹

参数

参数名类型必填说明
cloudPathstring云端文件或文件夹路径
isDirboolean是否为文件夹 默认值: false

findFiles

搜索静态网站托管的文件

参数

参数名类型必填说明
prefixstring匹配前缀
markerstring起始对象键标记
maxKeysnumber单次返回最大条目数

domainManagement

统一的域名管理工具,支持绑定、解绑、查询和修改域名配置

参数

参数名类型必填说明
actionstring操作类型: create=绑定域名, delete=解绑域名, check=查询域名配置, modify=修改域名配置 可填写的值: "create", "delete", "check", "modify"
domainstring域名
certIdstring证书ID(绑定域名时必需)
domainsarray of string域名列表(查询配置时使用)
domainIdnumber域名ID(修改配置时必需)
domainConfigobject域名配置(修改配置时使用)
domainConfig.Referobject
domainConfig.Refer.Switchstring
domainConfig.Refer.RefererRulesarray of object
domainConfig.Refer.RefererRules[].RefererTypestring
domainConfig.Refer.RefererRules[].Referersarray of string
domainConfig.Refer.RefererRules[].AllowEmptyboolean
domainConfig.Cachearray of object
domainConfig.Cache[].RuleTypestring
domainConfig.Cache[].RuleValuestring
domainConfig.Cache[].CacheTtlnumber
domainConfig.IpFilterobject
domainConfig.IpFilter.Switchstring
domainConfig.IpFilter.FilterTypestring
domainConfig.IpFilter.Filtersarray of string
domainConfig.IpFreqLimitobject
domainConfig.IpFreqLimit.Switchstring
domainConfig.IpFreqLimit.Qpsnumber

queryStorage

查询云存储信息,支持列出目录文件、获取文件信息、获取临时下载链接等只读操作。返回的文件信息包括文件名、大小、修改时间、下载链接等。

参数

参数名类型必填说明
actionstring查询操作类型:list=列出目录下的所有文件,info=获取指定文件的详细信息,url=获取文件的临时下载链接 可填写的值: "list", "info", "url"
cloudPathstring云端文件路径,例如 files/data.txt 或 files/(目录)
maxAgenumber临时链接有效期,单位为秒,取值范围:1-86400,默认值:3600(1小时) 默认值: 3600

manageStorage

管理云存储文件,支持上传文件/目录、下载文件/目录、删除文件/目录等操作。删除操作需要设置force=true进行确认,防止误删除重要文件。

参数

参数名类型必填说明
actionstring管理操作类型:upload=上传文件或目录,download=下载文件或目录,delete=删除文件或目录 可填写的值: "upload", "download", "delete"
localPathstring本地文件路径,建议传入绝对路径,例如 /tmp/files/data.txt
cloudPathstring云端文件路径,例如 files/data.txt
forceboolean强制操作开关,删除操作时建议设置为true以确认删除,默认false 默认值: false
isDirectoryboolean是否为目录操作,true=目录操作,false=文件操作,默认false 默认值: false

downloadTemplate

自动下载并部署CloudBase项目模板。⚠️ MANDATORY FOR NEW PROJECTS ⚠️

CRITICAL: This tool MUST be called FIRST when starting a new project.

支持的模板:

  • react: React + CloudBase 全栈应用模板
  • vue: Vue + CloudBase 全栈应用模板
  • miniprogram: 微信小程序 + 云开发模板
  • uniapp: UniApp + CloudBase 跨端应用模板
  • rules: 只包含AI编辑器配置文件(包含Cursor、WindSurf、CodeBuddy等所有主流编辑器配置),适合在已有项目中补充AI编辑器配置

支持的IDE类型:

  • all: 下载所有IDE配置(默认)
  • cursor: Cursor AI编辑器
  • windsurf: WindSurf AI编辑器
  • codebuddy: CodeBuddy AI编辑器
  • claude-code: Claude Code AI编辑器
  • cline: Cline AI编辑器
  • gemini-cli: Gemini CLI
  • opencode: OpenCode AI编辑器
  • qwen-code: 通义灵码
  • baidu-comate: 百度Comate
  • openai-codex-cli: OpenAI Codex CLI
  • augment-code: Augment Code
  • github-copilot: GitHub Copilot
  • roocode: RooCode AI编辑器
  • tongyi-lingma: 通义灵码
  • trae: Trae AI编辑器
  • qoder: Qoder AI编辑器
  • antigravity: Google Antigravity AI编辑器
  • vscode: Visual Studio Code

特别说明:

  • rules 模板会自动包含当前 mcp 版本号信息(版本号:2.5.0),便于后续维护和版本追踪
  • 下载 rules 模板时,如果项目中已存在 README.md 文件,系统会自动保护该文件不被覆盖(除非设置 overwrite=true)

参数

参数名类型必填说明
templatestring要下载的模板类型 可填写的值: "react", "vue", "miniprogram", "uniapp", "rules"
idestring指定要下载的IDE类型。如果未指定,会根据 INTEGRATION_IDE 环境变量自动选择对应的IDE配置;如果环境变量也未设置,则默认下载所有IDE配置 可填写的值: "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"
overwriteboolean是否覆盖已存在的文件,默认为false(不覆盖)

interactiveDialog

统一的交互式对话工具,支持需求澄清和任务确认,当需要和用户确认下一步的操作的时候,可以调用这个工具的clarify,如果有敏感的操作,需要用户确认,可以调用这个工具的confirm

参数

参数名类型必填说明
typestring交互类型: clarify=需求澄清, confirm=任务确认 可填写的值: "clarify", "confirm"
messagestring对话消息内容
optionsarray of string可选的预设选项
forceUpdateboolean是否强制更新环境ID配置
risksarray of string操作风险提示

searchWeb

使用联网来进行信息检索,如查询最新的新闻、文章、股价、天气等。支持自然语言查询,也可以直接输入网址获取网页内容

参数

参数名类型必填说明
querystring搜索关键词、问题或网址,支持自然语言

searchKnowledgeBase

云开发知识库智能检索工具,支持向量查询 (vector)、固定文档 (doc) 和 OpenAPI 文档 (openapi) 查询。

  强烈推荐始终优先使用固定文档 (doc) 或 OpenAPI 文档 (openapi) 模式进行检索,仅当固定文档无法覆盖你的问题时,再使用向量查询 (vector) 模式。

固定文档 (doc) 查询当前支持 16 个固定文档,分别是:
文档名:auth-http-api 文档介绍: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.

文档名:auth-nodejs 文档介绍:Complete guide for CloudBase Auth using the CloudBase Node SDK – caller identity, user lookup, custom login tickets, and server-side best practices. 文档名:auth-web 文档介绍: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. 文档名:auth-wechat 文档介绍:Complete guide for WeChat Mini Program authentication with CloudBase - native login, user identity, and cloud function integration. 文档名:cloudbase-platform 文档介绍: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. 文档名:cloudrun-development 文档介绍: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. 文档名:data-model-creation 文档介绍:Optional advanced tool for complex data modeling. For simple table creation, use relational-database-tool directly with SQL statements. 文档名:http-api 文档介绍: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. 文档名:miniprogram-development 文档介绍:WeChat Mini Program development rules. Use this skill when developing WeChat mini programs, integrating CloudBase capabilities, and deploying mini program projects. 文档名:no-sql-web-sdk 文档介绍:Use CloudBase document database Web SDK to query, create, update, and delete data. Supports complex queries, pagination, aggregation, and geolocation queries. 文档名:no-sql-wx-mp-sdk 文档介绍:Use CloudBase document database WeChat MiniProgram SDK to query, create, update, and delete data. Supports complex queries, pagination, aggregation, and geolocation queries. 文档名:relational-database-tool 文档介绍: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. 文档名:relational-database-web 文档介绍: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. 文档名:spec-workflow 文档介绍: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. 文档名:ui-design 文档介绍: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. 文档名:web-development 文档介绍:Web frontend project development rules. Use this skill when developing web frontend pages, deploying static hosting, and integrating CloudBase Web SDK.

  OpenAPI 文档 (openapi) 查询当前支持 5 个 API 文档,分别是:
API名:mysqldb API介绍:MySQL RESTful API - 云开发 MySQL 数据库 HTTP API

API名:functions API介绍:Cloud Functions API - 云函数 HTTP API API名:auth API介绍:Authentication API - 身份认证 HTTP API API名:cloudrun API介绍:CloudRun API - 云托管服务 HTTP API API名:storage API介绍:Storage API - 云存储 HTTP API

参数

参数名类型必填说明
modestring可填写的值: "vector", "doc", "openapi"
docNamestringmode=doc 时指定。文档名称。 可填写的值: "auth-http-api", "auth-nodejs", "auth-web", "auth-wechat", "cloudbase-platform", "cloudrun-development", "data-model-creation", "http-api", "miniprogram-development", "no-sql-web-sdk", "no-sql-wx-mp-sdk", "relational-database-tool", "relational-database-web", "spec-workflow", "ui-design", "web-development"
apiNamestringmode=openapi 时指定。API 名称。 可填写的值: "mysqldb", "functions", "auth", "cloudrun", "storage"
thresholdnumbermode=vector 时指定。相似性检索阈值 默认值: 0.5
idstringmode=vector 时指定。知识库范围,cloudbase=云开发全量知识,scf=云开发的云函数知识, miniprogram=小程序知识(不包含云开发与云函数知识) 可填写的值: "cloudbase", "scf", "miniprogram"
contentstringmode=vector 时指定。检索内容
optionsobjectmode=vector 时指定。其他选项
options.chunkExpandarray of number指定返回的文档内容的展开长度,例如 [3,3]代表前后展开长度 默认值: [3,3]
limitnumbermode=vector 时指定。指定返回最相似的 Top K 的 K 的值 默认值: 5

queryCloudRun

查询云托管服务信息,支持获取服务列表、查询服务详情和获取可用模板列表。返回的服务信息包括服务名称、状态、访问类型、配置详情等。

参数

参数名类型必填说明
actionstring查询操作类型:list=获取云托管服务列表(支持分页和筛选),detail=查询指定服务的详细信息(包括配置、版本、访问地址等),templates=获取可用的项目模板列表(用于初始化新项目) 可填写的值: "list", "detail", "templates"
pageSizenumber分页大小,控制每页返回的服务数量。取值范围:1-100,默认值:10。建议根据网络性能和显示需求调整 默认值: 10
pageNumnumber页码,用于分页查询。从1开始,默认值:1。配合pageSize使用可实现分页浏览 默认值: 1
serverNamestring服务名称筛选条件,支持模糊匹配。例如:输入"test"可匹配"test-service"、"my-test-app"等服务名称。留空则查询所有服务
serverTypestring服务类型筛选条件:function=函数型云托管(仅支持Node.js,有特殊的开发要求和限制,适合简单的API服务),container=容器型服务(推荐使用,支持任意语言和框架如Java/Go/Python/PHP/.NET等,适合大多数应用场景) 可填写的值: "function", "container"
detailServerNamestring要查询详细信息的服务名称。当action为detail时必需提供,必须是已存在的服务名称。可通过list操作获取可用的服务名称列表

manageCloudRun

管理云托管服务,按开发顺序支持:初始化项目(可从模板开始,模板列表可通过 queryCloudRun 查询)、下载服务代码、本地运行(仅函数型服务)、部署代码、删除服务。部署可配置CPU、内存、实例数、访问类型等参数。删除操作需要确认,建议设置force=true。

参数

参数名类型必填说明
actionstring云托管服务管理操作类型:init=从模板初始化新的云托管项目代码(在targetPath目录下创建以serverName命名的子目录,支持多种语言和框架模板),download=从云端下载现有服务的代码到本地进行开发,run=在本地运行函数型云托管服务(用于开发和调试,仅支持函数型服务),deploy=将本地代码部署到云端云托管服务(支持函数型和容器型),delete=删除指定的云托管服务(不可恢复,需要确认),createAgent=创建函数型Agent(基于函数型云托管开发AI智能体) 可填写的值: "init", "download", "run", "deploy", "delete", "createAgent"
serverNamestring云托管服务名称,用于标识和管理服务。命名规则:支持大小写字母、数字、连字符和下划线,必须以字母开头,长度3-45个字符。在init操作中会作为在targetPath下创建的子目录名,在其他操作中作为目标服务名
targetPathstring本地代码路径,必须是绝对路径。在deploy操作中指定要部署的代码目录,在download操作中指定下载目标目录,在init操作中指定云托管服务的上级目录(会在该目录下创建以serverName命名的子目录)。建议约定:项目根目录下的cloudrun/目录,例如:/Users/username/projects/my-project/cloudrun
serverConfigobject服务配置项,用于部署时设置服务的运行参数。包括资源规格、访问权限、环境变量等配置。不提供时使用默认配置
serverConfig.OpenAccessTypesarray of string公网访问类型配置,控制服务的访问权限:OA=办公网访问,PUBLIC=公网访问(默认,可通过HTTPS域名访问),MINIAPP=小程序访问,VPC=VPC访问(仅同VPC内可访问)。可配置多个类型
serverConfig.CpunumberCPU规格配置,单位为核。可选值:0.25、0.5、1、2、4、8等。注意:内存规格必须是CPU规格的2倍(如CPU=0.25时内存=0.5,CPU=1时内存=2)。影响服务性能和计费
serverConfig.Memnumber内存规格配置,单位为GB。可选值:0.5、1、2、4、8、16等。注意:必须是CPU规格的2倍。影响服务性能和计费
serverConfig.MinNumnumber最小实例数配置,控制服务的最小运行实例数量。设置为0时支持缩容到0(无请求时不产生费用),设置为大于0时始终保持指定数量的实例运行(确保快速响应但会增加成本)。建议设置为1以降低冷启动延迟,提升用户体验
serverConfig.MaxNumnumber最大实例数配置,控制服务的最大运行实例数量。当请求量增加时,服务最多可以扩展到指定数量的实例,超过此数量后将拒绝新的请求。建议根据业务峰值设置
serverConfig.PolicyDetailsarray of object扩缩容配置数组,用于配置服务的自动扩缩容策略。可配置多个扩缩容策略
serverConfig.PolicyDetails[].PolicyTypestring扩缩容类型:cpu=基于CPU使用率扩缩容,mem=基于内存使用率扩缩容,cpu/mem=基于CPU和内存使用率扩缩容 可填写的值: "cpu", "mem", "cpu/mem"
serverConfig.PolicyDetails[].PolicyThresholdnumber扩缩容阈值,单位为百分比。如60表示当资源使用率达到60%时触发扩缩容
serverConfig.CustomLogsstring自定义日志配置,用于配置服务的日志收集和存储策略
serverConfig.Portnumber服务监听端口配置。函数型服务固定为3000,容器型服务可自定义。服务代码必须监听此端口才能正常接收请求
serverConfig.EnvParamsstring环境变量配置,JSON字符串格式。用于传递配置信息给服务代码,如'{"DATABASE_URL":"mysql://...","NODE_ENV":"production"}'。敏感信息建议使用环境变量而非硬编码
serverConfig.DockerfilestringDockerfile文件名配置,仅容器型服务需要。指定用于构建容器镜像的Dockerfile文件路径,默认为项目根目录下的Dockerfile
serverConfig.BuildDirstring构建目录配置,指定代码构建的目录路径。当代码结构与标准不同时使用,默认为项目根目录
serverConfig.InternalAccessstring内网访问开关配置,控制是否启用内网访问。true=启用内网访问(可通过云开发SDK直接调用),false=关闭内网访问(仅公网访问)
serverConfig.InternalDomainstring内网域名配置,用于配置服务的内网访问域名。仅在启用内网访问时有效
serverConfig.EntryPointarray of stringDockerfile EntryPoint参数配置,仅容器型服务需要。指定容器启动时的入口程序数组,如["node","app.js"]
serverConfig.Cmdarray of stringDockerfile Cmd参数配置,仅容器型服务需要。指定容器启动时的默认命令数组,如["npm","start"]
templatestring项目模板标识符,用于指定初始化项目时使用的模板。可通过queryCloudRun的templates操作获取可用模板列表。常用模板:helloworld=Hello World示例,nodejs=Node.js项目模板,python=Python项目模板等 默认值: "helloworld"
runOptionsobject本地运行参数配置,仅函数型云托管服务支持。用于配置本地开发环境的运行参数,不影响云端部署
runOptions.portnumber本地运行端口配置,仅函数型服务有效。指定服务在本地运行时监听的端口号,默认3000。确保端口未被其他程序占用 默认值: 3000
runOptions.envParamsobject本地运行时的附加环境变量配置,用于本地开发和调试。格式为键值对,如{"DEBUG":"true","LOG_LEVEL":"debug"}。这些变量仅在本地运行时生效
runOptions.runModestring运行模式:normal=普通函数模式,agent=Agent模式(用于AI智能体开发) 可填写的值: "normal", "agent";默认值: "normal"
runOptions.agentIdstringAgent ID,在agent模式下使用,用于标识特定的Agent实例
agentConfigobjectAgent配置项,仅在createAgent操作时使用
agentConfig.agentNamestringAgent名称,用于生成BotId
agentConfig.botTagstringBot标签,用于生成BotId,不提供时自动生成
agentConfig.descriptionstringAgent描述信息
agentConfig.templatestringAgent模板类型,默认为blank(空白模板) 默认值: "blank"
forceboolean强制操作开关,用于跳过确认提示。默认false(需要确认),设置为true时跳过所有确认步骤。删除操作时强烈建议设置为true以避免误操作 默认值: false
serverTypestring服务类型配置:function=函数型云托管(仅支持Node.js,有特殊的开发要求和限制,适合简单的API服务),container=容器型服务(推荐使用,支持任意语言和框架如Java/Go/Python/PHP/.NET等,适合大多数应用场景)。不提供时自动检测:1)现有服务类型 2)有Dockerfile→container 3)有@cloudbase/aiagent-framework依赖→function 4)其他情况→container 可填写的值: "function", "container"

createFunctionHTTPAccess

创建云函数的 HTTP 访问

参数

参数名类型必填说明
namestring函数名
pathstringHTTP 访问路径

downloadRemoteFile

下载远程文件到项目根目录下的指定相对路径。例如:小程序的 Tabbar 等素材图片,必须使用 png 格式,可以从 Unsplash、wikimedia【一般选用 500 大小即可、Pexels、Apple 官方 UI 等资源中选择来下载。

参数

参数名类型必填说明
urlstring远程文件的 URL 地址
relativePathstring相对于项目根目录的路径,例如:'assets/images/logo.png' 或 'docs/api.md'。不允许使用 ../ 等路径遍历操作。

readSecurityRule

读取指定资源(noSQL 数据库、SQL 数据库、云函数、存储桶)的安全规则和权限类别。

参数

参数名类型必填说明
resourceTypestring资源类型:noSqlDatabase=noSQL 数据库,sqlDatabase=SQL 数据库,function=云函数,storage=存储桶 可填写的值: "noSqlDatabase", "sqlDatabase", "function", "storage"
resourceIdstring资源唯一标识。noSQL 数据库为集合名,SQL 数据库为表名,云函数为函数名,存储为桶名。

writeSecurityRule

设置指定资源(数据库集合、云函数、存储桶)的安全规则。

参数

参数名类型必填说明
resourceTypestring资源类型:sqlDatabase=SQL 数据库,noSqlDatabase=noSQL 数据库,function=云函数,storage=存储桶 可填写的值: "sqlDatabase", "noSqlDatabase", "function", "storage"
resourceIdstring资源唯一标识。sqlDatabase=表名,noSqlDatabase=集合名,云函数为函数名,存储为桶名。
aclTagstring权限类别 可填写的值: "READONLY", "PRIVATE", "ADMINWRITE", "ADMINONLY", "CUSTOM"
rulestring自定义安全规则内容,仅当 aclTag 为 CUSTOM 时必填

activateInviteCode

云开发 AI编程激励计划,通过邀请码激活用户激励。

参数

参数名类型必填说明
InviteCodestring待激活的邀请码

callCloudApi

通用的云 API 调用工具,使用前请务必先阅读相关rules或skills,确认所需服务、Action 与 Param 的正确性和安全性

参数

参数名类型必填说明
servicestring选择要访问的服务,必须先查看规则/技能确认是否可用。可选:tcb、flexdb、scf、sts、cam、lowcode、cdn、vpc。 可填写的值: "tcb", "flexdb", "scf", "sts", "cam", "lowcode", "cdn", "vpc"
actionstring具体 Action 名称,需符合对应服务的 API 定义。
paramsobjectAction 对应的参数对象,键名需与官方 API 定义一致。某些 Action 需要携带 EnvId 等信息,如不清楚请在调用前查看rules/skill。