MCP 工具
当前包含 39 个工具。
源数据: tools.json
工具总览
名称 | 描述 |
---|---|
login | 登录云开发环境并选择要使用的环境 |
logout | 退出云开发环境 |
envQuery | 查询云开发环境相关信息,支持查询环境列表、当前环境信息和安全域名。(原工具名:listEnvs/getEnvInfo/getEnvAuthDomains,为兼容旧AI规则可继续使用这些名称) |
envDomainManagement | 管理云开发环境的安全域名,支持添加和删除操作。(原工具名:createEnvDomain/deleteEnvDomain,为兼容旧AI规则可继续使用这些名称) |
createCollection | 管理云开发数据库集合:默认创建。可通过 action 指定 update。 |
collectionQuery | 数据库集合的查询操作,支持检查存在性、查看详情、列表查询;并支持索引列表与检查。(兼容旧名称) |
updateCollection | 更新云开发数据库集合配置(创建或删除索引) |
checkIndexExists | 检查索引是否存在 |
insertDocuments | 向云开发数据库集合中插入一个或多个文档(支持对象数组) |
queryDocuments | 查询云开发数据库集合中的文档(支持对象参数) |
updateDocuments | 更新云开发数据库集合中的文档(支持对象参数) |
deleteDocuments | 删除云开发数据库集合中的文档(支持对象参数) |
manageDataModel | 数据模型查询工具,支持查询和列表数据模型(只读操作)。list操作返回基础信息(不含Schema),get操作返回详细信息(含简化的Schema,包括字段列表、格式、关联关系等),docs操作生成SDK使用文档 |
modifyDataModel | 基于Mermaid classDiagram创建或更新数据模型。支持创建新模型和更新现有模型结构。内置异步任务监控,自动轮询直至完成或超时。 |
getFunctionList | 获取云函数列表或单个函数详情,通过 action 参数区分操作类型 |
createFunction | 创建云函数 |
updateFunctionCode | 更新函数代码 |
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 | 上传文件到静态网站托管 |
getWebsiteConfig | 获取静态网站托管配置 |
deleteFiles | 删除静态网站托管的文件或文件夹 |
findFiles | 搜索静态网站托管的文件 |
domainManagement | 统一的域名管理工具,支持绑定、解绑、查询和修改域名配置 |
uploadFile | 上传文件到云存储(区别于静态网站托管,云存储更适合存储业务数据文件) |
downloadTemplate | 自动下载并部署CloudBase项目模板。<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/>- vscode: Visual Studio Code<br/>特别说明:<br/>- rules 模板会自动包含当前 mcp 版本号信息(版本号:1.8.38),便于后续维护和版本追踪<br/>- 下载 rules 模板时,如果项目中已存在 README.md 文件,系统会自动保护该文件不被覆盖(除非设置 overwrite=true) |
interactiveDialog | 统一的交互式对话工具,支持需求澄清和任务确认,当需要和用户确认下一步的操作的时候,可以调用这个工具的clarify,如果有敏感的操作,需要用户确认,可以调用这个工具的confirm |
searchWeb | 使用联网来进行信息检索,如查询最新的新闻、文章、股价、天气等。支持自然语言查询,也可以直接输入网址获取网页内容 |
searchKnowledgeBase | 云开发知识库智能检索工具,支持云开发与云函数知识的向量查询 |
queryCloudRun | 查询云托管服务信息,支持获取服务列表、查询服务详情和获取可用模板列表。返回的服务信息包括服务名称、状态、访问类型、配置详情等。 |
manageCloudRun | 管理云托管服务,按开发顺序支持:初始化项目(可从模板开始,模板列表可通过 queryCloudRun 查询)、下载服务代码、本地运行(仅函数型服务)、部署代码、删除服务。部署可配置CPU、内存、实例数、访问类型等参数。删除操作需要确认,建议设置force=true。 |
createFunctionHTTPAccess | 创建云函数的 HTTP 访问 |
downloadRemoteFile | 下载远程文件到本地临时文件,返回一个系统的绝对路径 |
readSecurityRule | 读取指定资源(数据库集合、云函数、存储桶)的安全规则和权限类别。<br/>参数说明:<br/>- resourceType: 资源类型(database/function/storage)<br/>- resourceId: 资源唯一标识(集合名/函数名/桶名) |
writeSecurityRule | 设置指定资源(数据库集合、云函数、存储桶)的安全规则。<br/>参数说明:<br/>- resourceType: 资源类型(database/function/storage)<br/>- resourceId: 资源唯一标识(集合名/函数名/桶名)<br/>- aclTag: 权限类别(READONLY/PRIVATE/ADMINWRITE/ADMINONLY/CUSTOM)<br/>- rule: 自定义安全规则内容,仅当 aclTag 为 CUSTOM 时必填 |
activateInviteCode | 云开发 AI编程激励计划,通过邀请码激活用户激励。 |
详细规格
login
登录云开发环境并选择要使用的环境
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
forceUpdate | boolean | 是否强制重新选择环境 |
logout
退出云开发环境
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
confirm | string | 是 | 确认操作,默认传 yes 可填写的值: const "yes" |
envQuery
查询云开发环境相关信息,支持查询环境列表、当前环境信息和安全域名。(原工具名:listEnvs/getEnvInfo/getEnvAuthDomains,为兼容旧AI规则可继续使用这些名称)
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
action | string | 是 | 查询类型:list=环境列表,info=当前环境信息,domains=安全域名列表 可填写的值: "list", "info", "domains" |
envDomainManagement
管理云开发环境的安全域名,支持添加和删除操作。(原工具名:createEnvDomain/deleteEnvDomain,为兼容旧AI规则可继续使用这些名称)
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
action | string | 是 | 操作类型:create=添加域名,delete=删除域名 可填写的值: "create", "delete" |
domains | array of string | 是 | 安全域名数组 |
createCollection
管理云开发数据库集合:默认创建。可通过 action 指定 update。
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
action | string | 操作类型:create=创建(默认),update=更新集合配置 可填写的值: "create", "update" | |
collectionName | string | 是 | 云开发数据库集合名称 |
options | object | 更新选项(action=update 时使用) | |
options.CreateIndexes | array of object | ||
options.CreateIndexes[].IndexName | string | 是 | |
options.CreateIndexes[].MgoKeySchema | object | 是 | |
options.CreateIndexes[].MgoKeySchema.MgoIsUnique | boolean | 是 | |
options.CreateIndexes[].MgoKeySchema.MgoIndexKeys | array of object | 是 | |
options.CreateIndexes[].MgoKeySchema.MgoIndexKeys[].Name | string | 是 | |
options.CreateIndexes[].MgoKeySchema.MgoIndexKeys[].Direction | string | 是 | |
options.DropIndexes | array of object | ||
options.DropIndexes[].IndexName | string | 是 |
collectionQuery
数据库集合的查询操作,支持检查存在性、查看详情、列表查询;并支持索引列表与检查。(兼容旧名称)
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
action | string | 是 | 操作类型:check=检查是否存在,describe=查看详情,list=列表查询,index_list=索引列表,index_check=检查索引是否存在 可填写的值: "check", "describe", "list", "index_list", "index_check" |
collectionName | string | 集合名称(check、describe、index_list、index_check 操作时必填) | |
indexName | string | 索引名称(index_check 操作时必填) | |
limit | number | 返回数量限制(list操作时可选) | |
offset | number | 偏移量(list操作时可选) |
updateCollection
更新云开发数据库集合配置(创建或删除索引)
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
collectionName | string | 是 | 云开发数据库集合名称 |
options | object | 是 | 更新选项,支持创建和删除索引 |
options.CreateIndexes | array of object | ||
options.CreateIndexes[].IndexName | string | 是 | |
options.CreateIndexes[].MgoKeySchema | object | 是 | |
options.CreateIndexes[].MgoKeySchema.MgoIsUnique | boolean | 是 | |
options.CreateIndexes[].MgoKeySchema.MgoIndexKeys | array of object | 是 | |
options.CreateIndexes[].MgoKeySchema.MgoIndexKeys[].Name | string | 是 | |
options.CreateIndexes[].MgoKeySchema.MgoIndexKeys[].Direction | string | 是 | |
options.DropIndexes | array of object | ||
options.DropIndexes[].IndexName | string | 是 |
checkIndexExists
检查索引是否存在
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
collectionName | string | 是 | 云开发数据库集合名称 |
indexName | string | 是 | 索引名称 |
insertDocuments
向云开发数据库集合中插入一个或多个文档(支持对象数组)
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
collectionName | string | 是 | 云开发数据库集合名称 |
documents | array of object | 是 | 要插入的文档对象数组,每个文档都是对象 |
queryDocuments
查询云开发数据库集合中的文档(支持对象参数)
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
collectionName | string | 是 | 云开发数据库集合名称 |
query | object \| string | 查询条件(对象或字符串,推荐对象) | |
projection | object \| string | 返回字段投影(对象或字符串,推荐对象) | |
sort | object \| string | 排序条件(对象或字符串,推荐对象) | |
limit | number | 返回数量限制 | |
offset | number | 跳过的记录数 |
updateDocuments
更新云开发数据库集合中的文档(支持对象参数)
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
collectionName | string | 是 | 云开发数据库集合名称 |
query | object \| string | 是 | 查询条件(对象或字符串,推荐对象) |
update | object \| string | 是 | 更新内容(对象或字符串,推荐对象) |
isMulti | boolean | 是否更新多条记录 | |
upsert | boolean | 是否在不存在时插入 |
deleteDocuments
删除云开发数据库集合中的文档(支持对象参数)
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
collectionName | string | 是 | 云开发数据库集合名称 |
query | object \| string | 是 | 查询条件(对象或字符串,推荐对象) |
isMulti | boolean | 是否删除多条记录 |
manageDataModel
数据模型查询工具,支持查询和列表数据模型(只读操作)。list操作返回基础信息(不含Schema),get操作返回详细信息(含简化的Schema,包括字段列表、格式、关联关系等),docs操作生成SDK使用文档
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
action | string | 是 | 操作类型:get=查询单个模型(含Schema字段列表、格式、关联关系),list=获取模型列表(不含Schema),docs=生成SDK使用文档 可填写的值: "get", "list", "docs" |
name | string | 模型名称(get操作时必填) | |
names | array of string | 模型名称数组(list操作时可选,用于过滤) |
modifyDataModel
基于Mermaid classDiagram创建或更新数据模型。支持创建新模型和更新现有模型结构。内置异步任务监控,自动轮询直至完成或超时。
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
mermaidDiagram | string | 是 | Mermaid classDiagram代码,描述数据模型结构。 |
action | string | 操作类型:create=创建新模型 可填写的值: "create", "update";默认值: "create" | |
publish | boolean | 是否立即发布模型 默认值: false | |
dbInstanceType | string | 数据库实例类型 默认值: "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 参数区分操作类型
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
action | string | 操作类型:list=获取函数列表(默认),detail=获取函数详情 可填写的值: "list", "detail" | |
limit | number | 范围(list 操作时使用) | |
offset | number | 偏移(list 操作时使用) | |
name | string | 函数名称(detail 操作时必需) | |
codeSecret | string | 代码保护密钥(detail 操作时使用) |
createFunction
创建云函数
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
func | object | 是 | 函数配置 |
func.name | string | 是 | 函数名称 |
func.timeout | number | 函数超时时间 | |
func.envVariables | object | 环境变量 | |
func.vpc | object | 私有网络配置 | |
func.vpc.vpcId | string | 是 | |
func.vpc.subnetId | string | 是 | |
func.runtime | string | 运行时环境,建议指定为 'Nodejs18.15',其他可选值:Nodejs18.15,Nodejs16.13,Nodejs14.18,Nodejs12.16,Nodejs10.15,Nodejs8.9 | |
func.triggers | array of object | Trigger configuration array | |
func.triggers[].name | string | 是 | Trigger name |
func.triggers[].type | string | 是 | Trigger type, currently only supports 'timer' 可填写的值: "timer" |
func.triggers[].config | string | 是 | Trigger 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.handler | string | 函数入口 | |
func.ignore | string \| array of string | 忽略文件 | |
func.isWaitInstall | boolean | 是否等待依赖安装 | |
func.layers | array of object | Layer配置 | |
func.layers[].name | string | 是 | |
func.layers[].version | number | 是 | |
functionRootPath | string | 函数根目录(云函数目录的父目录),这里需要传操作系统上文件的绝对路径,注意:不要包含函数名本身,例如函数名为 'hello',应传入 '/path/to/cloudfunctions',而不是 '/path/to/cloudfunctions/hello' | |
force | boolean | 是 | 是否覆盖 |
updateFunctionCode
更新函数代码
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 函数名称 |
functionRootPath | string | 是 | 函数根目录(云函数目录的父目录),这里需要传操作系统上文件的绝对路径 |
updateFunctionConfig
更新云函数配置
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
funcParam | object | 是 | 函数配置 |
funcParam.name | string | 是 | 函数名称 |
funcParam.timeout | number | 超时时间 | |
funcParam.envVariables | object | 环境变量 | |
funcParam.vpc | object | VPC配置 | |
funcParam.vpc.vpcId | string | 是 | |
funcParam.vpc.subnetId | string | 是 |
invokeFunction
调用云函数
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 函数名称 |
params | object | 调用参数 |
getFunctionLogs
获取云函数日志基础信息(LogList),如需日志详情请用 RequestId 调用 getFunctionLogDetail 工具。此接口基于 manger-node 4.4.0+ 的 getFunctionLogsV2 实现,不返回具体日志内容。参数 offset+limit 不得大于 10000,startTime/endTime 间隔不得超过一天。
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 函数名称 |
offset | number | 数据的偏移量,Offset+Limit 不能大于 10000 | |
limit | number | 返回数据的长度,Offset+Limit 不能大于 10000 | |
startTime | string | 查询的具体日期,例如:2017-05-16 20:00:00,只能与 EndTime 相差一天之内 | |
endTime | string | 查询的具体日期,例如:2017-05-16 20:59:59,只能与 StartTime 相差一天之内 | |
requestId | string | 执行该函数对应的 requestId | |
qualifier | string | 函数版本,默认为 $LATEST |
getFunctionLogDetail
根据 getFunctionLogs 返回的 RequestId 查询日志详情。参数 startTime、endTime、requestId,返回日志内容(LogJson 等)。仅支持 manger-node 4.4.0+。
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
startTime | string | 查询的具体日期,例如:2017-05-16 20:00:00,只能与 EndTime 相差一天之内 | |
endTime | string | 查询的具体日期,例如:2017-05-16 20:59:59,只能与 StartTime 相差一天之内 | |
requestId | string | 是 | 执行该函数对应的 requestId |
manageFunctionTriggers
创建或删除云函数触发器,通过 action 参数区分操作类型
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
action | string | 是 | 操作类型:create=创建触发器,delete=删除触发器 可填写的值: "create", "delete" |
name | string | 是 | 函数名 |
triggers | array of object | 触发器配置数组(创建时必需) | |
triggers[].name | string | 是 | Trigger name |
triggers[].type | string | 是 | Trigger type, currently only supports 'timer' 可填写的值: "timer" |
triggers[].config | string | 是 | Trigger 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) |
triggerName | string | 触发器名称(删除时必需) |
uploadFiles
上传文件到静态网站托管
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
localPath | string | 本地文件或文件夹路径,需要是绝对路径,例如 /tmp/files/data.txt | |
cloudPath | string | 云端文件或文件夹路径,例如files/data.txt | |
files | array of object | 多文件上传配置 默认值: [] | |
files[].localPath | string | 是 | |
files[].cloudPath | string | 是 | |
ignore | string \| array of string | 忽略文件模式 |
getWebsiteConfig
获取静态网站托管配置
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
无 |
deleteFiles
删除静态网站托管的文件或文件夹
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
cloudPath | string | 是 | 云端文件或文件夹路径 |
isDir | boolean | 是否为文件夹 默认值: false |
findFiles
搜索静态网站托管的文件
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
prefix | string | 是 | 匹配前缀 |
marker | string | 起始对象键标记 | |
maxKeys | number | 单次返回最大条目数 |
domainManagement
统一的域名管理工具,支持绑定、解绑、查询和修改域名配置
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
action | string | 是 | 操作类型: create=绑定域名, delete=解绑域名, check=查询域名配置, modify=修改域名配置 可填写的值: "create", "delete", "check", "modify" |
domain | string | 域名 | |
certId | string | 证书ID(绑定域名时必需) | |
domains | array of string | 域名列表(查询配置时使用) | |
domainId | number | 域名ID(修改配置时必需) | |
domainConfig | object | 域名配置(修改配置时使用) | |
domainConfig.Refer | object | ||
domainConfig.Refer.Switch | string | 是 | |
domainConfig.Refer.RefererRules | array of object | ||
domainConfig.Refer.RefererRules[].RefererType | string | 是 | |
domainConfig.Refer.RefererRules[].Referers | array of string | 是 | |
domainConfig.Refer.RefererRules[].AllowEmpty | boolean | 是 | |
domainConfig.Cache | array of object | ||
domainConfig.Cache[].RuleType | string | 是 | |
domainConfig.Cache[].RuleValue | string | 是 | |
domainConfig.Cache[].CacheTtl | number | 是 | |
domainConfig.IpFilter | object | ||
domainConfig.IpFilter.Switch | string | 是 | |
domainConfig.IpFilter.FilterType | string | ||
domainConfig.IpFilter.Filters | array of string | ||
domainConfig.IpFreqLimit | object | ||
domainConfig.IpFreqLimit.Switch | string | 是 | |
domainConfig.IpFreqLimit.Qps | number |
uploadFile
上传文件到云存储(区别于静态网站托管,云存储更适合存储业务数据文件)
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
localPath | string | 是 | 本地文件路径,建议传入绝对路径,例如 /tmp/files/data.txt |
cloudPath | string | 是 | 云端文件路径,例如 files/data.txt |
downloadTemplate
自动下载并部署CloudBase项目模板。
支持的模板:
- 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编辑器
- vscode: Visual Studio Code
特别说明:
- rules 模板会自动包含当前 mcp 版本号信息(版本号:1.8.38),便于后续维护和版本追踪
- 下载 rules 模板时,如果项目中已存在 README.md 文件,系统会自动保护该文件不被覆盖(除非设置 overwrite=true)
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
template | string | 是 | 要下载的模板类型 可填写的值: "react", "vue", "miniprogram", "uniapp", "rules" |
ide | string | 指定要下载的IDE类型,默认为all(下载所有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", "vscode";默认值: "all" | |
overwrite | boolean | 是否覆盖已存在的文件,默认为false(不覆盖) |
interactiveDialog
统一的交互式对话工具,支持需求澄清和任务确认,当需要和用户确认下一步的操作的时候,可以调用这个工具的clarify,如果有敏感的操作,需要用户确认,可以调用这个工具的confirm
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 交互类型: clarify=需求澄清, confirm=任务确认 可填写的值: "clarify", "confirm" |
message | string | 对话消息内容 | |
options | array of string | 可选的预设选项 | |
forceUpdate | boolean | 是否强制更新环境ID配置 | |
risks | array of string | 操作风险提示 |
searchWeb
使用联网来进行信息检索,如查询最新的新闻、文章、股价、天气等。支持自然语言查询,也可以直接输入网址获取网页内容
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
query | string | 是 | 搜索关键词、问题或网址,支持自然语言 |
searchKnowledgeBase
云开发知识库智能检索工具,支持云开发与云函数知识的向量查询
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
threshold | number | 相似性检索阈值 默认值: 0.5 | |
id | string | 是 | 知识库范围,cloudbase=云开发全量知识,scf=云开发的云函数知识, miniprogram=小程序知识(不包含云开发与云函数知识) 可填写的值: "cloudbase", "scf", "miniprogram" |
content | string | 是 | 检索内容 |
options | object | 其他选项 | |
options.chunkExpand | array of number | 指定返回的文档内容的展开长度,例如 [3,3]代表前后展开长度 默认值: [3,3] | |
limit | number | 指定返回最相似的 Top K 的 K 的值 默认值: 5 |
queryCloudRun
查询云托管服务信息,支持获取服务列表、查询服务详情和获取可用模板列表。返回的服务信息包括服务名称、状态、访问类型、配置详情等。
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
action | string | 是 | 查询操作类型:list=获取云托管服务列表(支持分页和筛选),detail=查询指定服务的详细信息(包括配置、版本、访问地址等),templates=获取可用的项目模板列表(用于初始化新项目) 可填写的值: "list", "detail", "templates" |
pageSize | number | 分页大小,控制每页返回的服务数量。取值范围:1-100,默认值:10。建议根据网络性能和显示需求调整 默认值: 10 | |
pageNum | number | 页码,用于分页查询。从1开始,默认值:1。配合pageSize使用可实现分页浏览 默认值: 1 | |
serverName | string | 服务名称筛选条件,支持模糊匹配。例如:输入"test"可匹配"test-service"、"my-test-app"等服务名称。留空则查询所有服务 | |
serverType | string | 服务类型筛选条件:function=函数型云托管(简化开发模式,支持WebSocket/SSE/文件上传等特性,适合快速开发),container=容器型服务(传统容器部署模式,支持任意语言和框架,适合复杂应用) 可填写的值: "function", "container" | |
detailServerName | string | 要查询详细信息的服务名称。当action为detail时必需提供,必须是已存在的服务名称。可通过list操作获取可用的服务名称列表 |
manageCloudRun
管理云托管服务,按开发顺序支持:初始化项目(可从模板开始,模板列表可通过 queryCloudRun 查询)、下载服务代码、本地运行(仅函数型服务)、部署代码、删除服务。部署可配置CPU、内存、实例数、访问类型等参数。删除操作需要确认,建议设置force=true。
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
action | string | 是 | 云托管服务管理操作类型:init=从模板初始化新的云托管项目代码(在targetPath目录下创建以serverName命名的子目录,支持多种语言和框架模板),download=从云端下载现有服务的代码到本地进行开发,run=在本地运行函数型云托管服务(用于开发和调试,仅支持函数型服务),deploy=将本地代码部署到云端云托管服务(支持函数型和容器型),delete=删除指定的云托管服务(不可恢复,需要确认),createAgent=创建函数型Agent(基于函数型云托管开发AI智能体) 可填写的值: "init", "download", "run", "deploy", "delete", "createAgent" |
serverName | string | 是 | 云托管服务名称,用于标识和管理服务。命名规则:支持大小写字母、数字、连字符和下划线,必须以字母开头,长度3-45个字符。在init操作中会作为在targetPath下创建的子目录名,在其他操作中作为目标服务名 |
targetPath | string | 本地代码路径,必须是绝对路径。在deploy操作中指定要部署的代码目录,在download操作中指定下载目标目录,在init操作中指定云托管服务的上级目录(会在该目录下创建以serverName命名的子目录)。建议约定:项目根目录下的cloudrun/目录,例如:/Users/username/projects/my-project/cloudrun | |
serverConfig | object | 服务配置项,用于部署时设置服务的运行参数。包括资源规格、访问权限、环境变量等配置。不提供时使用默认配置 | |
serverConfig.OpenAccessTypes | array of string | 公网访问类型配置,控制服务的访问权限:WEB=公网访问(默认,可通过HTTPS域名访问),VPC=私有网络访问(仅同VPC内可访问),PRIVATE=内网访问(仅云开发环境内可访问)。可配置多个类型 | |
serverConfig.Cpu | number | CPU规格配置,单位为核。可选值:0.25、0.5、1、2、4、8等。注意:内存规格必须是CPU规格的2倍(如CPU=0.25时内存=0.5,CPU=1时内存=2)。影响服务性能和计费 | |
serverConfig.Mem | number | 内存规格配置,单位为GB。可选值:0.5、1、2、4、8、16等。注意:必须是CPU规格的2倍。影响服务性能和计费 | |
serverConfig.MinNum | number | 最小实例数配置,控制服务的最小运行实例数量。设置为0时支持缩容到0(无请求时不产生费用),设置为大于0时始终保持指定数量的实例运行(确保快速响应但会增加成本) | |
serverConfig.MaxNum | number | 最大实例数配置,控制服务的最大运行实例数量。当请求量增加时,服务最多可以扩展到指定数量的实例,超过此数量后将拒绝新的请求。建议根据业务峰值设置 | |
serverConfig.Port | number | 服务监听端口配置。函数型服务固定为3000,容器型服务可自定义。服务代码必须监听此端口才能正常接收请求 | |
serverConfig.EnvParams | object | 环境变量配置,用于传递配置信息给服务代码。格式为键值对,如{"DATABASE_URL":"mysql://..."}。敏感信息建议使用环境变量而非硬编码 | |
serverConfig.Dockerfile | string | Dockerfile文件名配置,仅容器型服务需要。指定用于构建容器镜像的Dockerfile文件路径,默认为项目根目录下的Dockerfile | |
serverConfig.BuildDir | string | 构建目录配置,指定代码构建的目录路径。当代码结构与标准不同时使用,默认为项目根目录 | |
serverConfig.InternalAccess | boolean | 内网访问开关配置,控制是否启用内网访问。true=启用内网访问(可通过云开发SDK直接调用),false=关闭内网访问(仅公网访问) | |
serverConfig.EntryPoint | string | Dockerfile EntryPoint参数配置,仅容器型服务需要。指定容器启动时的入口程序,如["node","app.js"] | |
serverConfig.Cmd | string | Dockerfile Cmd参数配置,仅容器型服务需要。指定容器启动时的默认命令,如["npm","start"] | |
template | string | 项目模板标识符,用于指定初始化项目时使用的模板。可通过queryCloudRun的templates操作获取可用模板列表。常用模板:helloworld=Hello World示例,nodejs=Node.js项目模板,python=Python项目模板等 默认值: "helloworld" | |
runOptions | object | 本地运行参数配置,仅函数型云托管服务支持。用于配置本地开发环境的运行参数,不影响云端部署 | |
runOptions.port | number | 本地运行端口配置,仅函数型服务有效。指定服务在本地运行时监听的端口号,默认3000。确保端口未被其他程序占用 默认值: 3000 | |
runOptions.envParams | object | 本地运行时的附加环境变量配置,用于本地开发和调试。格式为键值对,如{"DEBUG":"true","LOG_LEVEL":"debug"}。这些变量仅在本地运行时生效 | |
runOptions.runMode | string | 运行模式:normal=普通函数模式,agent=Agent模式(用于AI智能体开发) 可填写的值: "normal", "agent";默认值: "normal" | |
runOptions.agentId | string | Agent ID,在agent模式下使用,用于标识特定的Agent实例 | |
agentConfig | object | Agent配置项,仅在createAgent操作时使用 | |
agentConfig.agentName | string | 是 | Agent名称,用于生成BotId |
agentConfig.botTag | string | Bot标签,用于生成BotId,不提供时自动生成 | |
agentConfig.description | string | Agent描述信息 | |
agentConfig.template | string | Agent模板类型,默认为blank(空白模板) 默认值: "blank" | |
force | boolean | 强制操作开关,用于跳过确认提示。默认false(需要确认),设置为true时跳过所有确认步骤。删除操作时强烈建议设置为true以避免误操作 默认值: false |
createFunctionHTTPAccess
创建云函数的 HTTP 访问
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 函数名 |
path | string | 是 | HTTP 访问路径 |
downloadRemoteFile
下载远程文件到本地临时文件,返回一个系统的绝对路径
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
url | string | 是 | 远程文件的 URL 地址 |
readSecurityRule
读取指定资源(数据库集合、云函数、存储桶)的安全规则和权限类别。
参数说明:
- resourceType: 资源类型(database/function/storage)
- resourceId: 资源唯一标识(集合名/函数名/桶名)
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
resourceType | string | 是 | 资源类型:database=数据库集合,function=云函数,storage=存储桶 可填写的值: "database", "function", "storage" |
resourceId | string | 是 | 资源唯一标识。数据库为集合名,云函数为函数名,存储为桶名。 |
writeSecurityRule
设置指定资源(数据库集合、云函数、存储桶)的安全规则。
参数说明:
- resourceType: 资源类型(database/function/storage)
- resourceId: 资源唯一标识(集合名/函数名/桶名)
- aclTag: 权限类别(READONLY/PRIVATE/ADMINWRITE/ADMINONLY/CUSTOM)
- rule: 自定义安全规则内容,仅当 aclTag 为 CUSTOM 时必填
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
resourceType | string | 是 | 资源类型:database=数据库集合,function=云函数,storage=存储桶 可填写的值: "database", "function", "storage" |
resourceId | string | 是 | 资源唯一标识。数据库为集合名,云函数为函数名,存储为桶名。 |
aclTag | string | 是 | 权限类别 可填写的值: "READONLY", "PRIVATE", "ADMINWRITE", "ADMINONLY", "CUSTOM" |
rule | string | 自定义安全规则内容,仅当 aclTag 为 CUSTOM 时必填 |
activateInviteCode
云开发 AI编程激励计划,通过邀请码激活用户激励。
参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
InviteCode | string | 是 | 待激活的邀请码 |