跳到主要内容

MCP 工具

当前包含 39 个工具。

源数据: tools.json

工具总览​

名称描述
login登录云开发环境并选择要使用的环境
logout退出云开发环境
envQuery查询云开发环境相关信息，支持查询环境列表、当前环境信息、安全域名和静态网站托管配置。（原工具名：listEnvs/getEnvInfo/getEnvAuthDomains/getWebsiteConfig，为兼容旧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上传文件到静态网站托管
deleteFiles删除静态网站托管的文件或文件夹
findFiles搜索静态网站托管的文件
domainManagement统一的域名管理工具，支持绑定、解绑、查询和修改域名配置
queryStorage查询云存储信息，支持列出目录文件、获取文件信息、获取临时下载链接等只读操作。返回的文件信息包括文件名、大小、修改时间、下载链接等。
manageStorage管理云存储文件，支持上传文件/目录、下载文件/目录、删除文件/目录等操作。删除操作需要设置force=true进行确认，防止误删除重要文件。
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.41），便于后续维护和版本追踪<br/>- 下载 rules 模板时，如果项目中已存在 README.md 文件，系统会自动保护该文件不被覆盖（除非设置 overwrite=true）
interactiveDialog统一的交互式对话工具，支持需求澄清和任务确认，当需要和用户确认下一步的操作的时候，可以调用这个工具的clarify，如果有敏感的操作，需要用户确认，可以调用这个工具的confirm
searchWeb使用联网来进行信息检索，如查询最新的新闻、文章、股价、天气等。支持自然语言查询，也可以直接输入网址获取网页内容
searchKnowledgeBase云开发知识库智能检索工具，支持云开发与云函数知识的向量查询
queryCloudRun查询云托管服务信息，支持获取服务列表、查询服务详情和获取可用模板列表。返回的服务信息包括服务名称、状态、访问类型、配置详情等。
manageCloudRun管理云托管服务，按开发顺序支持：初始化项目（可从模板开始，模板列表可通过 queryCloudRun 查询）、下载服务代码、本地运行（仅函数型服务）、部署代码、删除服务。部署可配置CPU、内存、实例数、访问类型等参数。删除操作需要确认，建议设置force=true。
createFunctionHTTPAccess创建云函数的 HTTP 访问
downloadRemoteFile下载远程文件到项目根目录下的指定相对路径。例如：小程序的 Tabbar 等素材图片，必须使用 **png** 格式，可以从 Unsplash、wikimedia【一般选用 500 大小即可、Pexels、Apple 官方 UI 等资源中选择来下载。
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​

登录云开发环境并选择要使用的环境

参数​

参数名类型必填说明
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是安全域名数组

createCollection​

管理云开发数据库集合：默认创建。可通过 action 指定 update。

参数​

参数名类型必填说明
actionstring操作类型：create=创建(默认)，update=更新集合配置 可填写的值: "create", "update"
collectionNamestring是云开发数据库集合名称
optionsobject更新选项（action=update 时使用）
options.CreateIndexesarray of object
options.CreateIndexes[].IndexNamestring是
options.CreateIndexes[].MgoKeySchemaobject是
options.CreateIndexes[].MgoKeySchema.MgoIsUniqueboolean是
options.CreateIndexes[].MgoKeySchema.MgoIndexKeysarray of object是
options.CreateIndexes[].MgoKeySchema.MgoIndexKeys[].Namestring是
options.CreateIndexes[].MgoKeySchema.MgoIndexKeys[].Directionstring是
options.DropIndexesarray of object
options.DropIndexes[].IndexNamestring是

collectionQuery​

数据库集合的查询操作，支持检查存在性、查看详情、列表查询；并支持索引列表与检查。（兼容旧名称）

参数​

参数名类型必填说明
actionstring是操作类型：check=检查是否存在，describe=查看详情，list=列表查询，index_list=索引列表，index_check=检查索引是否存在 可填写的值: "check", "describe", "list", "index_list", "index_check"
collectionNamestring集合名称（check、describe、index_list、index_check 操作时必填）
indexNamestring索引名称（index_check 操作时必填）
limitnumber返回数量限制（list操作时可选）
offsetnumber偏移量（list操作时可选）

updateCollection​

更新云开发数据库集合配置（创建或删除索引）

参数​

参数名类型必填说明
collectionNamestring是云开发数据库集合名称
optionsobject是更新选项，支持创建和删除索引
options.CreateIndexesarray of object
options.CreateIndexes[].IndexNamestring是
options.CreateIndexes[].MgoKeySchemaobject是
options.CreateIndexes[].MgoKeySchema.MgoIsUniqueboolean是
options.CreateIndexes[].MgoKeySchema.MgoIndexKeysarray of object是
options.CreateIndexes[].MgoKeySchema.MgoIndexKeys[].Namestring是
options.CreateIndexes[].MgoKeySchema.MgoIndexKeys[].Directionstring是
options.DropIndexesarray of object
options.DropIndexes[].IndexNamestring是

checkIndexExists​

检查索引是否存在

参数​

参数名类型必填说明
collectionNamestring是云开发数据库集合名称
indexNamestring是索引名称

insertDocuments​

向云开发数据库集合中插入一个或多个文档（支持对象数组）

参数​

参数名类型必填说明
collectionNamestring是云开发数据库集合名称
documentsarray of object是要插入的文档对象数组，每个文档都是对象

queryDocuments​

查询云开发数据库集合中的文档（支持对象参数）

参数​

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

updateDocuments​

更新云开发数据库集合中的文档（支持对象参数）

参数​

参数名类型必填说明
collectionNamestring是云开发数据库集合名称
queryobject \| string是查询条件（对象或字符串，推荐对象）
updateobject \| string是更新内容（对象或字符串，推荐对象）
isMultiboolean是否更新多条记录
upsertboolean是否在不存在时插入

deleteDocuments​

删除云开发数据库集合中的文档（支持对象参数）

参数​

参数名类型必填说明
collectionNamestring是云开发数据库集合名称
queryobject \| string是查询条件（对象或字符串，推荐对象）
isMultiboolean是否删除多条记录

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创建或更新数据模型。支持创建新模型和更新现有模型结构。内置异步任务监控，自动轮询直至完成或超时。

参数​

参数名类型必填说明
mermaidDiagramstring是Mermaid 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[].namestring是Trigger name
func.triggers[].typestring是Trigger type, currently only supports 'timer' 可填写的值: "timer"
func.triggers[].configstring是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.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​

更新函数代码

参数​

参数名类型必填说明
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[].namestring是Trigger name
triggers[].typestring是Trigger type, currently only supports 'timer' 可填写的值: "timer"
triggers[].configstring是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)
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项目模板。

支持的模板:

  • 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.41），便于后续维护和版本追踪
  • 下载 rules 模板时，如果项目中已存在 README.md 文件，系统会自动保护该文件不被覆盖（除非设置 overwrite=true）

参数​

参数名类型必填说明
templatestring是要下载的模板类型 可填写的值: "react", "vue", "miniprogram", "uniapp", "rules"
idestring指定要下载的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"
overwriteboolean是否覆盖已存在的文件，默认为false（不覆盖）

interactiveDialog​

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

参数​

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

searchWeb​

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

参数​

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

searchKnowledgeBase​

云开发知识库智能检索工具，支持云开发与云函数知识的向量查询

参数​

参数名类型必填说明
thresholdnumber相似性检索阈值 默认值: 0.5
idstring是知识库范围，cloudbase=云开发全量知识，scf=云开发的云函数知识, miniprogram=小程序知识（不包含云开发与云函数知识） 可填写的值: "cloudbase", "scf", "miniprogram"
contentstring是检索内容
optionsobject其他选项
options.chunkExpandarray of number指定返回的文档内容的展开长度,例如 [3,3]代表前后展开长度 默认值: [3,3]
limitnumber指定返回最相似的 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=函数型云托管（简化开发模式，支持WebSocket/SSE/文件上传等特性，适合快速开发），container=容器型服务（传统容器部署模式，支持任意语言和框架，适合复杂应用） 可填写的值: "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公网访问类型配置，控制服务的访问权限：WEB=公网访问（默认，可通过HTTPS域名访问），VPC=私有网络访问（仅同VPC内可访问），PRIVATE=内网访问（仅云开发环境内可访问）。可配置多个类型
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时始终保持指定数量的实例运行（确保快速响应但会增加成本）
serverConfig.MaxNumnumber最大实例数配置，控制服务的最大运行实例数量。当请求量增加时，服务最多可以扩展到指定数量的实例，超过此数量后将拒绝新的请求。建议根据业务峰值设置
serverConfig.Portnumber服务监听端口配置。函数型服务固定为3000，容器型服务可自定义。服务代码必须监听此端口才能正常接收请求
serverConfig.EnvParamsobject环境变量配置，用于传递配置信息给服务代码。格式为键值对，如{"DATABASE_URL":"mysql://..."}。敏感信息建议使用环境变量而非硬编码
serverConfig.DockerfilestringDockerfile文件名配置，仅容器型服务需要。指定用于构建容器镜像的Dockerfile文件路径，默认为项目根目录下的Dockerfile
serverConfig.BuildDirstring构建目录配置，指定代码构建的目录路径。当代码结构与标准不同时使用，默认为项目根目录
serverConfig.InternalAccessboolean内网访问开关配置，控制是否启用内网访问。true=启用内网访问（可通过云开发SDK直接调用），false=关闭内网访问（仅公网访问）
serverConfig.EntryPointstringDockerfile EntryPoint参数配置，仅容器型服务需要。指定容器启动时的入口程序，如["node","app.js"]
serverConfig.CmdstringDockerfile 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.agentNamestring是Agent名称，用于生成BotId
agentConfig.botTagstringBot标签，用于生成BotId，不提供时自动生成
agentConfig.descriptionstringAgent描述信息
agentConfig.templatestringAgent模板类型，默认为blank（空白模板） 默认值: "blank"
forceboolean强制操作开关，用于跳过确认提示。默认false（需要确认），设置为true时跳过所有确认步骤。删除操作时强烈建议设置为true以避免误操作 默认值: false

createFunctionHTTPAccess​

创建云函数的 HTTP 访问

参数​

参数名类型必填说明
namestring是函数名
pathstring是HTTP 访问路径

downloadRemoteFile​

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

参数​

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

readSecurityRule​

读取指定资源（数据库集合、云函数、存储桶）的安全规则和权限类别。

参数说明：

  • resourceType: 资源类型（database/function/storage）
  • resourceId: 资源唯一标识（集合名/函数名/桶名）

参数​

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

writeSecurityRule​

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

参数说明：

  • resourceType: 资源类型（database/function/storage）
  • resourceId: 资源唯一标识（集合名/函数名/桶名）
  • aclTag: 权限类别（READONLY/PRIVATE/ADMINWRITE/ADMINONLY/CUSTOM）
  • rule: 自定义安全规则内容，仅当 aclTag 为 CUSTOM 时必填

参数​

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

activateInviteCode​

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

参数​

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