MCP 工具
CloudBase AI ToolKit 提供了完整的 MCP 工具集,支持云开发的各种操作。目前共有 43 个工具,涵盖环境管理、数据库操作、云函数管理、静态托管、小程序发布等核心功能。
📋 完整工具规格: 查看 tools.json
🔧 工具分类概览
分类 | 工具数量 | 主要功能 |
---|---|---|
🌍 环境管理 | 4 个 | 登录、环境信息查询、域名管理 |
🗄️ 数据库操作 | 11 个 | 集合管理、文档 CRUD、索引操作 |
⚡ 云函数管理 | 9 个 | 函数创建、更新、调用、日志 |
🌐 静态托管 | 6 个 | 文件上传、管理、域名配置 |
📁 文件操作 | 2 个 | 文件下载、云存储上传 |
📱 小程序发布 | 7 个 | 小程序上传、预览、构建、配置、调试、质量检查 |
🛠️ 工具支持 | 4 个 | 模板下载、知识库搜索、联网搜索、交互对话 |
🔒 安全规则管理 | 2 个 | 统一管理数据库、云函数、存储的安全规则 |
🌍 环境管理
🔐 身份认证
login
功能: 登录云开发环境并选择要使用的环境 参数:
forceUpdate
(boolean): 强制重新选择环境
logout
功能: 退出云开发环境 参数:
confirm
(boolean): 确认操作
📊 环境信息
envQuery
功能: 合并工具 - 查询环境列表、当前环境信息和安全域名 参数:
action
(string): list/info/domains
updateEnvInfo
功能: 更新云开发环境信息 参数:
alias
(string): 环境别名
🌐 域名管理
envDomainManagement
功能: 合并工具 - 管理环境安全域名(添加/删除) 参数:
action
(string): create/deletedomains
(array): 域名列表
🗄️ 数据库操作
📦 集合管理
createCollection
功能: 创建一个新的云开发数据库集合 参数:
collectionName
(string): 集合名称
collectionQuery
功能: 合并工具 - 检查集合存在性、查看详情、获取列表 参数:
action
(string): check/describe/list
updateCollection
功能: 更新集合配置(创建或删除索引) 参数:
collectionName
(string): 集合名称options
(object): 索引配置
checkIndexExists
功能: 检查索引是否存在 参数:
collectionName
(string): 集合名称indexName
(string): 索引名称
distribution
功能: 查询数据库中集合的数据分布情况 参数: 无参数
📄 文档操作
insertDocuments
功能: 向集合中插入一个或多个文档 参数:
collectionName
(string): 集合名称documents
(array): JSON字符串数组
queryDocuments
功能: 查询集合中的文档 参数:
collectionName
(string): 集合名称query
(object): 查询条件limit
(number): 限制数量offset
(number): 偏移量
updateDocuments
功能: 更新集合中的文档 参数:
collectionName
(string): 集合名称query
(object): 查询条件update
(object): 更新内容isMulti
(boolean): 是否批量更新
deleteDocuments
功能: 删除集合中的文档 参数:
collectionName
(string): 集合名称query
(object): 查询条件isMulti
(boolean): 是否批量删除
🎯 数据模型
manageDataModel
功能: 数据模型查询工具,支持查询和列表数据模型 参数:
action
(string): get/list/docsname
(string): 模型名
⚡ 云函数管理
📋 函数信息
getFunctionList
功能: 获取云函数列表 参数:
limit
(number): 分页限制offset
(number): 分页偏移
getFunctionDetail
功能: 获取云函数详情 参数:
name
(string): 函数名称
🔧 函数部署
createFunction
功能: 创建云函数 参数:
func
(object): 函数配置functionRootPath
(string): 函数根目录
updateFunctionCode
功能: 更新函数代码 参数:
name
(string): 函数名称functionRootPath
(string): 函数根目录runtime
(string): 运行时环境
updateFunctionConfig
功能: 更新云函数配置 参数:
funcParam
(object): 函数配置参数
🎮 函数运行
invokeFunction
功能: 调用云函数 参数:
name
(string): 函数名params
(object): 调用参数
getFunctionLogs
功能: 获取云函数日志(新版,仅返回基础信息LogList,不含日志详情) 参数:
name
(string): 函数名称offset
(number, 可选): 数据的偏移量,Offset+Limit 不能大于 10000limit
(number, 可选): 返回数据的长度,Offset+Limit 不能大于 10000startTime
(string, 可选): 查询的具体日期,例如:2017-05-16 20:00:00,只能与 EndTime 相差一天之内endTime
(string, 可选): 查询的具体日期,例如:2017-05-16 20:59:59,只能与 StartTime 相差一天之内requestId
(string, 可选): 执行该函数对应的 requestIdqualifier
(string, 可选): 函数版本,默认为 $LATEST 返回: LogList[],每条日志包含 RequestId、RetryNum、RetCode、StartTime 等基础信息。如需日志详情,请用 RequestId 调用 getFunctionLogDetail 工具。
getFunctionLogDetail
功能: 根据 getFunctionLogs 返回的 RequestId 查询日志详情 参数:
startTime
(string, 可选): 查询的具体日期,例如:2017-05-16 20:00:00,只能与 EndTime 相差一天之内endTime
(string, 可选): 查询的具体日期,例如:2017-05-16 20:59:59,只能与 StartTime 相差一天之内requestId
(string): 执行该函数对应的 RequestId 返回: 日志详情(LogJson、StartTime、Duration、MemUsage 等)
推荐用法:
- 先用 getFunctionLogs 查询日志列表,获得 RequestId。
- 再用 getFunctionLogDetail 查询具体日志内容。
🔗 函数触发器
createFunctionTriggers
功能: 创建云函数触发器 参数:
name
(string): 函数名triggers
(array): 触发器配置数组
deleteFunctionTrigger
功能: 删除云函数触发器 参数:
name
(string): 函数名triggerName
(string): 触发器名
🌐 HTTP 访问
createFunctionHTTPAccess
功能: 创建云函数的 HTTP 访问 参数:
name
(string): 函数名path
(string): 访问路径
🌐 静态托管
📤 文件管理
uploadFiles
功能: 上传文件到静态网站托管 参数:
localPath
(string): 本地路径cloudPath
(string): 云端路径files
(array): 多文件配置
deleteFiles
功能: 删除静态网站托管的文件或文件夹 参数:
cloudPath
(string): 云端路径isDir
(boolean): 是否为目录
findFiles
功能: 搜索静态网站托管的文件 参数:
prefix
(string): 匹配前缀maxKeys
(number): 返回数量
⚙️ 网站配置
getWebsiteConfig
功能: 获取静态网站托管配置 参数: 无参数
domainManagement
功能: 统一的域名管理工具,支持绑定、解绑、查询和修改域名配置 参数:
action
(string): create/delete/check/modify
📁 文件操作
🔄 文件传输
downloadRemoteFile
功能: 下载远程文件到本地临时文件 参数:
url
(string): 远程文件 URL
uploadFile
功能: 上传文件到云存储(适合存储业务数据文件) 参数:
localPath
(string): 本地路径cloudPath
(string): 云端路径
📱 小程序发布
📤 代码管理
uploadMiniprogramCode
功能: 上传小程序代码到微信平台 参数:
appId
(string): 小程序 appIdprojectPath
(string): 项目路径version
(string): 版本号desc
(string): 版本描述setting
(object): 编译设置robot
(number): 机器人编号 1-30type
(string): 项目类型 miniProgram/miniGame
previewMiniprogramCode
功能: 预览小程序代码并生成二维码 参数:
appId
(string): 小程序 appIdprojectPath
(string): 项目路径desc
(string): 预览描述setting
(object): 编译设置robot
(number): 机器人编号 1-30type
(string): 项目类型 miniProgram/miniGameqrcodeFormat
(string): 二维码格式 image/base64/terminalqrcodeOutputDest
(string): 二维码输出路径pagePath
(string): 预览页面路径searchQuery
(string): 预览页面参数
🔧 项目管理
buildMiniprogramNpm
功能: 构建小程序 npm 包 参数:
appId
(string): 小程序 appIdprojectPath
(string): 项目路径type
(string): 项目类型 miniProgram/miniGamerobot
(number): 机器人编号 1-30
getMiniprogramProjectConfig
功能: 获取小程序项目配置 参数:
appId
(string): 小程序 appIdprojectPath
(string): 项目路径type
(string): 项目类型 miniProgram/miniGame
🔍 调试与质量
getMiniprogramSourceMap
功能: 获取最近上传版本的 SourceMap,用于生产环境错误调试 参数:
appId
(string): 小程序 appIdprojectPath
(string): 项目路径robot
(number): 指定使用哪一个 ci 机器人,1-30sourceMapSavePath
(string): SourceMap 保存路径type
(string): 项目类型 miniProgram/miniGame
checkMiniprogramCodeQuality
功能: 检查小程序代码质量,生成质量报告(需要 miniprogram-ci 1.9.11+) 参数:
appId
(string): 小程序 appIdprojectPath
(string): 项目路径saveReportPath
(string): 质量报告保存路径type
(string): 项目类型 miniProgram/miniGame
packMiniprogramNpmManually
功能: 自定义 node_modules 位置的小程序 npm 构建,支持复杂项目结构 参数:
packageJsonPath
(string): 希望被构建的 node_modules 对应的 package.json 的路径miniprogramNpmDistDir
(string): 被构建 miniprogram_npm 的目标位置ignores
(array): 指定需要排除的规则
🛠️ 工具支持
📚 辅助工具
downloadTemplate
功能: 下载CloudBase项目模板(React、小程序、AI编辑器配置等) 参数:
template
(string): react/vue/miniprogram/uniapp/rules
searchKnowledgeBase
功能: 智能检索云开发知识库,通过向量搜索获取专业文档与答案 参数:
id
(string): cloudbase/scf/miniprogramcontent
(string): 检索内容
searchWeb
功能: 联网搜索工具,支持查询最新信息和访问网页内容 参数:
query
(string): 搜索关键词、问题或网址
interactiveDialog
功能: 统一的交互式对话工具,支持需求澄清和任务确认 参数:
type
(string): clarify/confirmmessage
(string): 对话内容
🔒 安全规则管理
readSecurityRule
功能: 读取指定资源(数据库集合、云函数、存储桶)的安全规则和权限类别。 参数:
resourceType
(string): 资源类型(database/function/storage)resourceId
(string): 资源唯一标识(集合名/函数名/桶名) 返回:aclTag
(string): 权限类别rule
(string|null): 自定义安全规则内容raw
(object): 原始返回
writeSecurityRule
功能: 设置指定资源的安全规则。 参数:
resourceType
(string): 资源类型(database/function/storage)resourceId
(string): 资源唯一标识envId
(string): 环境IDaclTag
(string): 权限类别(READONLY/PRIVATE/ADMINWRITE/ADMINONLY/CUSTOM)rule
(string, 可选): 自定义安全规则内容,仅当 aclTag 为 CUSTOM 时必填 返回:requestId
(string): 请求唯一标识raw
(object): 原始返回
🎁 激励计划
activateInviteCode
功能: 云开发 AI编程激励计划,通过邀请码激活用户激励 参数:
InviteCode
(string): 待激活的邀请码
示例:
{
"InviteCode": "TCBAI666"
}
返回:
ErrorCode
(string): 错误码,成功为空ErrorMsg
(string): 错误信息,成功为空RequestId
(string): 请求唯一标识
典型错误码说明:
- 邀请码无效
- 不能使用本人邀请码进行激活
- 激活次数已达上限
- 非新用户无法激活
- 已参与过活动
- 奖励发放完毕
- 并发失败需重试
🚀 使用方式
这些工具会在你与 AI 对话时自动调用,无需手动执行。例如:
- 💬 "登录云开发" → AI 调用
login
工具 - 🔍 "查询环境信息" → AI 调用
envQuery
工具 - 🚀 "部署应用" → AI 调用相关的部署工具
- 📊 "查询数据库" → AI 调用
queryDocuments
工具 - 📱 "上传小程序" → AI 调用
uploadMiniprogramCode
工具
⚙️ 配置说明
MCP 工具通过以下配置添加到你的 AI IDE 中:
{
"mcpServers": {
"cloudbase-mcp": {
"command": "npx",
"args": ["@cloudbase/cloudbase-mcp@latest"]
}
}
}
云端 MCP 配置说明
如果在云端环境中使用 MCP 时,需要配置腾讯云密钥等环境变量
环境变量
- 需要将 TENCENTCLOUD_SECRETID 和 TENCENTCLOUD_SECRETKEY 配置在腾讯云控制台获取的 SecretId 和 SecretKey 获取腾讯云密钥
- 需要将 CLOUDBASE_ENV_ID 配置为您在云开发控制台获取的环境 ID 获取云开发环境 ID
{
"mcpServers": {
"cloudbase-mcp": {
"command": "npx",
"args": ["-y", "@cloudbase/cloudbase-mcp"],
"env": {
"TENCENTCLOUD_SECRETID": "腾讯云 SecretId",
"TENCENTCLOUD_SECRETKEY": "腾讯云 SecretKey",
"CLOUDBASE_ENV_ID": "云开发环境 ID"
}
}
}
}