跳到主要内容

MCP 工具

当前包含 38 个工具,按功能分组如下。

源数据: tools.json


工具总览

认证与登录

其他

环境管理

NoSQL 数据库

数据模型

PostgreSQL 数据库

PostgreSQL 云存储

云函数

静态托管

云存储

模板与文件

搜索与知识库

云托管

网关

应用认证

权限管理

日志

AI Agent

激励计划

云 API


云端 MCP 配置说明

环境变量配置

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

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

详细规格

auth

CloudBase(腾讯云开发)开发阶段登录与环境绑定。登录后即可访问云资源;环境(env)是云函数、数据库、静态托管等资源的隔离单元,绑定环境后其他 MCP 工具才能操作该环境。支持:查询状态、发起登录、绑定环境(set_env)、退出登录。

参数

action
string

动作:status=查询状态,start_auth=发起登录,set_env=绑定环境(传envId),logout=退出登录 可填写的值: "status", "start_auth", "set_env", "logout", "get_temp_credentials"

authMode
string

认证模式:device=设备码授权,web=浏览器回调授权 可填写的值: "device", "web"

oauthEndpoint
string

高级可选:自定义 device-code 登录 endpoint。配置后 oauthCustom 默认按 true 处理

clientId
string

高级可选:自定义 device-code 登录 client_id,不传则使用默认值

oauthCustom
boolean

高级可选:自定义 endpoint 返回格式开关。未配置 endpoint 时默认 false;配置 endpoint 后默认 true,且不能设为 false

envId
string

环境ID(CloudBase 环境唯一标识),绑定后工具将操作该环境。action=set_env 时必填

confirm
string

action=logout 时确认操作,传 yes 可填写的值: const "yes"

reveal
boolean

action=get_temp_credentials 时可选。true=返回明文临时密钥;默认 false 仅返回脱敏结果


queryEnv

查询 CloudBase 环境相关信息,支持查询环境列表、指定环境详情和安全域名。(曾用名:envQuery、listEnvs、getEnvInfo、getEnvAuthDomains)当 action=list 时,会按 DescribeEnvs 语义做列表/筛选,标准返回字段为 EnvId、Alias、Status、EnvType、Region、PackageId、PackageName、IsDefault,并支持通过 fields 白名单裁剪这些字段;aliasExact=true 时会按别名精确筛选,避免把前缀相近的环境误当作候选;即使传入 envId,action=list 也只返回摘要,不会返回完整资源明细或 expiry。如需查询某个已知 EnvId 对应环境的详细信息(包括资源字段和计费信息),必须使用 action=info 并传入目标环境的 envId 参数。action=info 会在可用时补充 BillingInfo(如 ExpireTime、PayMode、IsAutoRenew 等计费字段)。

🔍 action=info 还会派生三个用于后端选型的字段:

  • EnvInfo.RuntimeMode:'postgresql' 或 'nosql',表示新业务建议默认使用的后端(PG 已开通时为 postgresql,否则为 nosql)。
  • EnvInfo.RuntimeBackends\{postgresql, nosql, mysql\} 三个布尔值,描述当前环境实际并存的后端。
  • EnvInfo.RuntimeModeHints:每个后端对应的 API/工具/skill 提示。

AI 在写业务/权限/存储代码前必须先看这三项:PG 模式下新业务推荐 app.rdb() + RLS(managePgDatabase action=executeCREATE POLICY)+ pgstore;已存在的 NoSQL 集合 / 旧 storage / managePermissions(resourceType="noSqlDatabase") 在 PG 环境下仍然有效。真正不适用的是 MySQL:当 RuntimeBackends.mysql === false 时,manageSqlDatabase / querySqlDatabase / relational-database-tool skill 都不该使用。

参数

action
string

查询类型:list=环境列表/摘要筛选(按 DescribeEnvs 语义筛选,支持通过 envId 筛选,返回 EnvId、Alias、Status、EnvType、Region、PackageId、PackageName、IsDefault,不支持 expiry),info=指定环境的详细信息(必须传入 envId,返回资源字段和计费信息),domains=安全域名列表 可填写的值: "list", "info", "domains"

alias
string

按环境别名筛选。action=list 时可选

aliasExact
boolean

按环境别名精确筛选。action=list 时可选;与 alias 配合使用

envId
string

按环境 ID 筛选。action=list 时可选(仅按 DescribeEnvs 语义做筛选,仍返回摘要);action=info 时必填(返回该环境的详细信息,包含资源字段和计费信息)。如果任务已经给出了明确的 EnvId 并要求查询详情,请直接使用 action=info + envId,而不是 action=list

limit
integer

返回数量上限。action=list 时可选

offset
integer

分页偏移。action=list 时可选

fields
array of string

返回字段白名单。仅支持 EnvId、Alias、Status、EnvType、Region、PackageId、PackageName、IsDefault。action=list 时可选


envQuery

查询 CloudBase 环境相关信息,支持查询环境列表、指定环境详情和安全域名。(曾用名:envQuery、listEnvs、getEnvInfo、getEnvAuthDomains)当 action=list 时,会按 DescribeEnvs 语义做列表/筛选,标准返回字段为 EnvId、Alias、Status、EnvType、Region、PackageId、PackageName、IsDefault,并支持通过 fields 白名单裁剪这些字段;aliasExact=true 时会按别名精确筛选,避免把前缀相近的环境误当作候选;即使传入 envId,action=list 也只返回摘要,不会返回完整资源明细或 expiry。如需查询某个已知 EnvId 对应环境的详细信息(包括资源字段和计费信息),必须使用 action=info 并传入目标环境的 envId 参数。action=info 会在可用时补充 BillingInfo(如 ExpireTime、PayMode、IsAutoRenew 等计费字段)。

🔍 action=info 还会派生三个用于后端选型的字段:

  • EnvInfo.RuntimeMode:'postgresql' 或 'nosql',表示新业务建议默认使用的后端(PG 已开通时为 postgresql,否则为 nosql)。
  • EnvInfo.RuntimeBackends\{postgresql, nosql, mysql\} 三个布尔值,描述当前环境实际并存的后端。
  • EnvInfo.RuntimeModeHints:每个后端对应的 API/工具/skill 提示。

AI 在写业务/权限/存储代码前必须先看这三项:PG 模式下新业务推荐 app.rdb() + RLS(managePgDatabase action=executeCREATE POLICY)+ pgstore;已存在的 NoSQL 集合 / 旧 storage / managePermissions(resourceType="noSqlDatabase") 在 PG 环境下仍然有效。真正不适用的是 MySQL:当 RuntimeBackends.mysql === false 时,manageSqlDatabase / querySqlDatabase / relational-database-tool skill 都不该使用。

参数

action
string

查询类型:list=环境列表/摘要筛选(按 DescribeEnvs 语义筛选,支持通过 envId 筛选,返回 EnvId、Alias、Status、EnvType、Region、PackageId、PackageName、IsDefault,不支持 expiry),info=指定环境的详细信息(必须传入 envId,返回资源字段和计费信息),domains=安全域名列表 可填写的值: "list", "info", "domains"

alias
string

按环境别名筛选。action=list 时可选

aliasExact
boolean

按环境别名精确筛选。action=list 时可选;与 alias 配合使用

envId
string

按环境 ID 筛选。action=list 时可选(仅按 DescribeEnvs 语义做筛选,仍返回摘要);action=info 时必填(返回该环境的详细信息,包含资源字段和计费信息)。如果任务已经给出了明确的 EnvId 并要求查询详情,请直接使用 action=info + envId,而不是 action=list

limit
integer

返回数量上限。action=list 时可选

offset
integer

分页偏移。action=list 时可选

fields
array of string

返回字段白名单。仅支持 EnvId、Alias、Status、EnvType、Region、PackageId、PackageName、IsDefault。action=list 时可选


envDomainManagement

管理 CloudBase 环境的安全域名(安全域名 / CORS 白名单),支持添加和删除操作。(原工具名:createEnvDomain/deleteEnvDomain,为兼容旧AI规则可继续使用这些名称)当浏览器 Web 应用需要从本地 Vite / dev server 直接访问 CloudBase 资源时,应先用 queryEnv(action=domains) 检查当前实际浏览器 origin 对应的 host:port 是否已在白名单中,再按该实际值添加。新增或删除后通常需要继续轮询 queryEnv(action=domains) 确认状态收敛;安全域名一般约 10 分钟生效。⚠️ 重要:此工具仅用于 CORS/请求来源验证,不涉及 SSL 证书。如需绑定自定义域名供公网 HTTPS 访问,请使用 manageGateway(action="bindCustomDomain")。

参数

action
string

操作类型:create=添加安全域名,delete=删除安全域名 可填写的值: "create", "delete"

domains
array of string

安全域名数组(格式:host:port,例如 localhost:5173 或 127.0.0.1:4173)。注意:不是自定义域名,不需要证书。


manageEnv

管理 CloudBase 环境,支持:listPackages=查询可选套餐列表,create=创建新环境(需确认),modifyPlan=变更套餐(升降配,需确认),renew=续费环境(需确认)。

⚠️ 所有涉及费用的操作(create/modifyPlan/renew),执行前必须展示配置摘要并等待用户通过 confirm="yes" 确认。

参数

action
string

操作类型:listPackages=查询可选套餐,create=创建环境,modifyPlan=变更套餐,renew=续费 可填写的值: "listPackages", "create", "modifyPlan", "renew"

alias
string

环境别名(action=create 时必填)。要求:小写字母/数字/减号,不能以减号开头或结尾,最长 20 位

packageId
string

套餐 ID(action=create/modifyPlan 时必填)。可选值如 baas_personal(个人版)、baas_pf_standard(标准版)、baas_pf_enterprise(企业版)

region
string

环境地域(action=create 时可选)。默认 ap-shanghai,可选 ap-guangzhou、ap-beijing 等

resources
array of string

启用的资源类型(action=create 时可选)。默认启用全部四项:flexdb(文档数据库)、storage(存储)、function(云函数)、postgresql(PostgreSQL 数据库)

duration
integer

购买或续费时长(月),action=create/renew 时可选,默认 1

envId
string

环境 ID(action=modifyPlan/renew 时必填)

confirm
string

确认操作。所有付费操作(create/modifyPlan/renew)必须传 "yes" 确认 可填写的值: const "yes"


readNoSqlDatabaseStructure

读取 CloudBase NoSQL 数据库集合与索引结构,支持列出集合、查看集合详情、列出索引以及检查索引是否存在。本工具为服务端管理工具,用于管理端查询数据库结构,不用于编写客户端代码。

参数

action
string

listCollections: 列出集合列表 describeCollection: 描述集合详情(会返回索引摘要) checkCollection: 检查集合是否存在 listIndexes: 列出指定集合的索引列表 checkIndex: 检查指定索引是否存在 可填写的值: "listCollections", "describeCollection", "checkCollection", "listIndexes", "checkIndex"

limit
number

返回数量限制(listCollections 操作时可选)

offset
number

偏移量(listCollections 操作时可选)

collectionName
string

集合名称(describeCollection、listIndexes、checkIndex 操作时必填)

indexName
string

索引名称(checkIndex 操作时必填)


writeNoSqlDatabaseStructure

创建、删除和管理 CloudBase NoSQL 数据库集合(collection)。支持创建新集合、删除现有集合,以及通过 updateCollection 的 updateOptions.CreateIndexes / updateOptions.DropIndexes 添加索引和删除索引。当需要新建集合时,使用 action=createCollection。本工具为服务端管理工具,用于管理端操作集合和索引结构,不用于编写客户端代码。

参数

action
string

createCollection: 创建集合 updateCollection: 更新集合配置;添加索引请传 updateOptions.CreateIndexes,删除索引请传 updateOptions.DropIndexes deleteCollection: 删除集合 可填写的值: "createCollection", "updateCollection", "deleteCollection"

collectionName
string

集合名称

updateOptions
object

更新选项(updateCollection 时使用)。CreateIndexes 用于添加索引,DropIndexes 用于删除索引。


readNoSqlDatabaseContent

查询 CloudBase NoSQL 数据库中的数据记录。支持按条件筛选、分页、排序,适用于管理端数据查询与运维。

参数

collectionName
string

集合名称

instanceId
string

可选:显式指定数据库实例ID;未传时会自动解析并缓存

query
union

查询条件(对象或字符串,推荐对象)

projection
union

返回字段投影(对象或字符串,推荐对象)

sort
union

排序条件,仅支持数组 [{"key":"createdAt","direction":-1}] 或对应 JSON 字符串。

limit
number

返回数量限制

offset
number

跳过的记录数


writeNoSqlDatabaseContent

修改 CloudBase NoSQL 数据库中的数据记录。支持插入、更新(含 $set/$inc/$push 等操作符)、删除、upsert 等操作,适用于管理端数据写入与运维。⚠️ 服务端写入不含 _openid:若集合依赖客户端 SDK(@cloudbase/js-sdk 或微信小程序 wx.cloud.database())的行级安全规则(如 doc._openid == auth.openid),服务端写入时需手动补充 _openid 字段,否则客户端将无法读取到该数据。⚠️ 部分更新嵌套字段须使用点号路径,如 $set: \{"shipping.city": "guangzhou"\},直接传嵌套对象会覆盖整个字段。

参数

action
string

insert: 插入数据(新增文档) update: 更新数据 delete: 删除数据 可填写的值: "insert", "update", "delete"

collectionName
string

集合名称

instanceId
string

可选:显式指定数据库实例ID;未传时会自动解析并缓存

documents
array of object

要插入的文档对象数组,每个文档都是对象(insert 操作必填)

query
union

查询条件(对象或字符串,推荐对象)(update/delete 操作必填)

update
union

更新内容(对象或字符串,推荐对象)(update 操作必填)。按 MongoDB 更新语义传入 MgoUpdate:部分更新请使用 `$set`、`$inc`、`$unset`、`$push` 等操作符,例如使用 `$set` 更新 `status`;不要直接传"字段到值的普通对象",否则可能替换整条文档。 ⚠️ 嵌套字段必须用点号路径(如 `shipping.city`),禁止整对象替换: - ❌ 错误:{ "$set": { "shipping": { "city": "guangzhou" } } } — shipping 被整块替换,原有 address/province 等字段全部丢失 - ✅ 正确:{ "$set": { "shipping.city": "guangzhou" } } — 仅更新 city,shipping 下其他字段保留

isMulti
boolean

是否更新多条记录(update/delete 操作可选)

upsert
boolean

是否在不存在时插入(update 操作可选)


manageDataModel

数据模型查询工具,支持查询和列表数据模型(只读操作)。通过 action 参数区分操作类型:list=获取模型列表(不含Schema,可选 names 参数过滤),get=查询单个模型详情(含Schema字段列表、格式、关联关系等,需要提供 name 参数),docs=生成SDK使用文档(需要提供 name 参数)

参数

action
string

操作类型:get=查询单个模型(含Schema字段列表、格式、关联关系,需要提供 name 参数),list=获取模型列表(不含Schema,可选 names 参数过滤),docs=生成SDK使用文档(需要提供 name 参数) 可填写的值: "get", "list", "docs"

name
string

要查询的数据模型名称。当 action='get' 或 action='docs' 时,此参数为必填项,必须提供已存在的数据模型名称。可通过 action='list' 操作获取可用的模型名称列表

names
array of string

模型名称数组(list操作时可选,用于过滤)


modifyDataModel

基于Mermaid classDiagram创建数据模型。为保持兼容性,工具名仍为 modifyDataModel;当前仅支持创建新模型,不支持更新现有模型结构。内置异步任务监控,自动轮询直至完成或超时。

参数

mermaidDiagram
string

Mermaid classDiagram代码,描述数据模型结构。 示例: 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 "身份模型"

action
string

操作类型:create=创建新模型 可填写的值: "create"

publish
boolean

是否立即发布模型

dbInstanceType
string

数据库实例类型,可选值:MYSQL=MySQL 数据库,FLEXDB=文档型数据库(NoSQL) 可填写的值: "MYSQL", "FLEXDB"


queryPgDatabase

查询 CloudBase PostgreSQL 数据库。支持获取当前 PG 上下文、列出带 schema 的数据库对象、读取轻量元数据、检查单个对象结构,以及执行只读 SQL。

参数

action
string

操作类型:context=获取当前 PostgreSQL 上下文;objects=列出带 schema 的数据库对象;metadata=获取轻量表元数据;schema=检查单个带 schema 的对象结构;sql=执行只读 SQL 可填写的值: "context", "objects", "metadata", "schema", "sql"

sql
string

action=sql 时使用的只读 SQL

objectName
string

action=schema 时使用的带 schema 的 PostgreSQL 对象名,例如 public.users

schema
string

可选的 schema 过滤条件,用于 action=objects 或 action=metadata

limit
integer

可选的摘要数量上限,用于对象、元数据或 SQL 返回行数,默认 20,最大 200。


managePgDatabase

管理 CloudBase PostgreSQL MCP 上下文。仅支持 CloudBase 内置 PostgreSQL 云端 Manager SDK 执行路径、SQL 风险预检、迁移规划,以及在显式确认后执行写入 SQL。

参数

action
string

操作类型:init=初始化或绑定 PostgreSQL 上下文;execute=执行已确认的写入 SQL 或 DDL;dryRun=只分析 SQL 风险不执行;planMigration=通过 PreviewPGUserMigrations 预览迁移计划;applyMigration=通过 PushPGUserMigrations 应用迁移;listMigrations=查询已应用的 Migration 列表;migrationDetail=查看单条 Migration 详情;rollbackMigration=回滚指定 Migration 可填写的值: "init", "execute", "dryRun", "planMigration", "applyMigration", "listMigrations", "migrationDetail", "rollbackMigration"

sql
string

action=execute、dryRun、planMigration 或 applyMigration 使用的 SQL 语句

confirm
boolean

执行任何写入 SQL 前都需要显式设置为 true。

envId
string

可选的 CloudBase 环境 ID,不传时使用当前 MCP 环境。

instanceId
string

可选的 PostgreSQL 逻辑实例标识。

defaultSchema
string

默认 schema,会保存到 PG 上下文中,默认 public。

role
string

可选的 PostgreSQL role,会传给 Manager SDK executePGSql;例如需要管理策略时可传 postgres。

objectName
string

action=migrationDetail 或 rollbackMigration 时使用的 migration ID。


queryPgStorage

查询 CloudBase PostgreSQL 环境下的云存储能力。返回 bucket/config 能力摘要、对象信息查询方案,以及基于 HTTP API 或 SDK 的上传实现方案;不会读取本地文件,也不会默认输出大量签名 URL。

参数

action
string

操作类型:buckets/config=查询存储能力摘要;uploadPlan=生成 HTTP API/SDK 上传方案;objectInfo=生成对象元信息查询方案;signUpload/signDownload=显式的一次性签名 URL 请求占位 可填写的值: "buckets", "config", "uploadPlan", "objectInfo", "signUpload", "signDownload"

bucket
string

云存储 bucket 名称

objectKey
string

单个对象 key

objectKeys
array of string

多个对象 key,用于对象元信息查询规划

objects
array of object

待上传对象的元信息。文件字节内容不会通过 MCP 传递。

expiresIn
integer

签名 URL 有效期,单位秒,范围 60 到 86400。


queryFunctions

CloudBase 云函数统一只读入口。通过更自解释的 action 查询 CloudBase 云函数列表、函数详情、执行日志、层、触发器和代码下载地址。

分页说明listFunctionslistLayers 支持 limitoffset 参数。

  • limit: 分页数量,默认值由后端决定
  • offset: 分页偏移,从 0 开始
  • 示例:queryFunctions(action="listFunctions", offset=10, limit=10)

查询 CloudBase 云函数日志:使用 action="listFunctionLogs",需要提供 functionName 参数。

  • 示例:queryFunctions(action="listFunctionLogs", functionName="my-function")
  • 如需查看日志详情:queryFunctions(action="getFunctionLogDetail", requestId="xxx")

定时任务 / cron / 定时跑:使用 listFunctionTriggers 查询函数的 timer 触发器配置。

区分 queryLogs 工具

  • 本工具用于查询特定 CloudBase 云函数的执行日志
  • queryLogs 工具用于搜索 CLS 日志服务(跨服务日志聚合)

参数

action
string

只读操作类型: - `listFunctions`: 列出所有 CloudBase 云函数 - `getFunctionDetail`: 获取 CloudBase 云函数详情(需要 functionName) - `listFunctionLogs`: 查询 CloudBase 云函数执行日志(需要 functionName) - `getFunctionLogDetail`: 获取日志详情(需要 requestId) - `listFunctionLayers`: 列出函数绑定的层 - `listLayers`: 列出所有层 - `listLayerVersions`: 列出层的版本(注意:是 Versions 不是 Version) - `getLayerVersionDetail`: 获取层版本详情 - `listFunctionTriggers`: 列出函数触发器(用于查看定时任务 / cron / timer 配置) - `getFunctionDownloadUrl`: 获取函数代码下载地址 可填写的值: "listFunctions", "getFunctionDetail", "listFunctionLogs", "getFunctionLogDetail", "listFunctionLayers", "listLayers", "listLayerVersions", "getLayerVersionDetail", "listFunctionTriggers", "getFunctionDownloadUrl"

functionName
string

CloudBase 云函数名称。`getFunctionDetail`、`listFunctionLogs`、`listFunctionLayers`、`listFunctionTriggers`、`getFunctionDownloadUrl` 时必填

limit
number

分页数量(limit)。列表类 action 可选,默认值由后端决定

offset
number

分页偏移(offset)。列表类 action 可选,默认 0

codeSecret
string

代码保护密钥,用于解密函数代码

startTime
string

日志查询开始时间,格式必须为 YYYY-MM-DD HH:mm:ss(如 2024-01-01 00:00:00)。与 endTime 间隔不能超过一天。不传时默认查询最近一天

endTime
string

日志查询结束时间,格式必须为 YYYY-MM-DD HH:mm:ss(如 2024-01-01 23:59:59)。与 startTime 间隔不能超过一天。不传时默认为当前时间

requestId
string

日志请求 ID。`getFunctionLogDetail` 操作必填,可从 `listFunctionLogs` 结果中获取

qualifier
string

函数版本别名,如 $LATEST、$DEFAULT。日志查询时可选

runtime
string

层查询的运行时筛选,如 Nodejs18.15

searchKey
string

层名称搜索关键字

layerName
string

层名称。`listLayerVersions`、`getLayerVersionDetail` 操作必填

layerVersion
number

层版本号。`getLayerVersionDetail` 操作必填


manageFunctions

CloudBase 云函数统一写入口。支持创建函数、更新代码、更新配置、调用函数、管理定时跑 / 定时任务 / scheduled job 的 timer 触发器和层绑定。如果要创建 cron 定时任务,先用 createFunction 创建函数,再用 createFunctionTrigger 创建 timer 触发器(支持7段cron表达式),deleteFunctionTrigger 删除触发器。危险操作需要显式 confirm=true。

参数

action
string

写操作类型,例如 createFunction、updateFunctionCode、incrementalDeployFunction、invokeFunction、deleteFunction、createFunctionTrigger(定时任务 / cron / timer)、deleteFunctionTrigger、attachLayer、detachLayer 可填写的值: "createFunction", "updateFunctionCode", "updateFunctionConfig", "invokeFunction", "deleteFunction", "createFunctionTrigger", "deleteFunctionTrigger", "createLayerVersion", "deleteLayerVersion", "attachLayer", "detachLayer", "updateFunctionLayers", "incrementalDeployFunction"

func
object

createFunction 操作的函数配置

functionRootPath
string

创建或更新函数代码时默认推荐的本地目录方式。必须是直接包含函数文件夹的目录绝对路径(如 /abs/path/cloudfunctions 或 /abs/path/functions),不要传项目根目录(如 /abs/path),也不要传到函数名子目录(如 /abs/path/cloudfunctions/hello)。本地应按 cloudfunctions/<functionName>/index.js 或 functions/<functionName>/index.js 布局,此参数传 cloudfunctions 或 functions 目录的绝对路径。SDK 会自动拼接函数名子目录,无需预先压缩 zip 或 base64 编码。

force
boolean

createFunction 时是否覆盖

functionName
string

函数名称。大多数 action 使用该字段作为统一目标

zipFile
string

仅兼容特殊场景:预先准备好的代码包 base64 编码。普通 createFunction/updateFunctionCode 默认不要先压缩 zip,优先使用 functionRootPath。

handler
string

函数入口

timeout
number

配置更新时的超时时间

envVariables
object

配置更新时要合并的环境变量

vpc
unknown

配置更新时的 VPC 信息

params
object

invokeFunction 的调用参数

triggers
array of unknown

createFunctionTrigger 的触发器列表,用于定时跑 / 定时任务 / scheduled job。timer 触发器使用7段 cron 表达式(秒 分 时 日 月 星期 年),如 "0 */5 * * * * *" 表示每5分钟执行一次

triggerName
string

deleteFunctionTrigger 的目标触发器名称

layerName
string

层名称

layerVersion
number

层版本号

contentPath
string

层内容路径,可为目录或 ZIP 文件

base64Content
string

层内容的 base64 编码

runtimes
array of string

层适用的运行时列表

description
string

层版本描述

licenseInfo
string

层许可证信息

layers
array of object

updateFunctionLayers 的目标层列表,顺序即最终顺序

codeSecret
string

层绑定时的代码保护密钥

confirm
boolean

危险操作确认开关。deleteFunction、deleteFunctionTrigger、deleteLayerVersion、detachLayer 等删除类操作需要显式传入 confirm=true

incrementalFile
string

incrementalDeployFunction 增量部署时的变更文件路径


queryHosting

查询 CloudBase 静态托管的只读信息。适合 AI 先做发现再决定下一步:action=websiteConfig 查询首页/错误页/路由规则与站点域名信息;action=status 查询托管服务状态;action=findFiles 按前缀查找文件;action=listFiles 列出全部托管文件;action=domainStatus 查询自定义域名的当前状态与配置。该工具不会产生任何副作用。

参数

action
string

查询类型:websiteConfig=查询静态托管网站文档配置与站点域名信息,status=查询静态托管服务状态,findFiles=按前缀查找托管文件,listFiles=列出静态托管中的全部文件,domainStatus=查询自定义域名配置与生效状态。该工具严格只读,不会修改任何资源。 可填写的值: "websiteConfig", "status", "findFiles", "listFiles", "domainStatus"

prefix
string

文件前缀过滤条件。仅 action=findFiles 时使用,例如 app/ 或 assets/logo。

marker
string

分页起始标记。仅 action=findFiles 时使用,用于续查上一页之后的结果。

maxKeys
integer

单次返回的最大文件条数。仅 action=findFiles 时使用。

domains
array of string

要查询的自定义域名列表。仅 action=domainStatus 时使用,例如 ["www.example.com"]。


manageHosting

管理 CloudBase 静态托管的变更操作。action=upload 上传本地构建产物到共享域名(域名格式:<envId>-<appId>.tcloudbaseapp.com/<cloudPath>);action=delete 删除托管文件或目录(必须 confirm=true);action=setWebsiteDocument 设置首页/错误页/路由规则;action=enableService 开通静态托管;action=bindDomain / unbindDomain / updateDomain 管理自定义域名;action=downloadFile / downloadDirectory 下载托管内容到本地。⚠️ 新项目部署优先使用 manageApps(部署到独立子域名),本工具适合已有老项目继续使用或作为 manageApps 的 fallback。manageApps 与 manageHosting 域名不同,切换会导致老链接失效。若任务只是查看配置、文件或域名状态,请改用 queryHosting。

参数

action
string

管理类型:upload=上传本地构建产物到静态托管,delete=删除静态托管文件或目录,setWebsiteDocument=设置首页/错误页/路由规则,enableService=开通静态托管服务,bindDomain=绑定自定义域名,unbindDomain=解绑自定义域名,updateDomain=更新域名缓存/防盗链/IP 规则,downloadFile=下载单个托管文件到本地,downloadDirectory=下载托管目录到本地。 可填写的值: "upload", "delete", "setWebsiteDocument", "enableService", "bindDomain", "unbindDomain", "updateDomain", "downloadFile", "downloadDirectory"

localPath
string

本地路径。action=upload 时表示要上传的本地文件/目录路径;action=downloadFile 或 downloadDirectory 时表示下载到本地的目标路径。建议传绝对路径。

cloudPath
string

静态托管中的目标路径。action=upload 时表示上传后的托管路径;action=delete/downloadFile/downloadDirectory 时表示托管侧文件或目录路径。

files
array of object

多文件上传配置。仅 action=upload 时可选;传入后会逐项上传,不再依赖单个 localPath/cloudPath。

ignore
union

上传时忽略的文件模式。仅 action=upload 时可选,例如 node_modules 或 ["**/*.map", "**/.DS_Store"]。

isDir
boolean

是否把 cloudPath 视为目录。仅 action=delete 时使用;true=删除目录,false=删除单个文件。

confirm
boolean

高风险操作确认开关。action=delete 和 action=unbindDomain 时必须显式传 true,避免误删文件或误解绑域名。

indexDocument
string

网站首页文档名称。仅 action=setWebsiteDocument 时必填,例如 index.html。

errorDocument
string

错误页文档名称。仅 action=setWebsiteDocument 时可选,例如 404.html。

routingRules
array of object

网站路由规则列表。仅 action=setWebsiteDocument 时可选。SPA 常见配置是将 404 重写到 index.html。

domain
string

自定义域名。action=bindDomain / unbindDomain / updateDomain 时使用,例如 www.example.com。

certId
string

证书 ID。仅 action=bindDomain 时必填。

domainId
number

域名 ID。仅 action=updateDomain 时必填,用于精确更新指定域名配置。

domainConfig
object

域名配置。仅 action=updateDomain 时必填,支持缓存、Referer、防盗链、IP 规则与频控。


queryStorage

查询 CloudBase 云存储信息,支持列出目录文件、获取文件信息、获取临时下载链接等只读操作。返回的文件信息包括文件名、大小、修改时间、下载链接等。注意:action=url 返回的 temporaryUrl 是临时签名链接,有效期由 maxAge 参数决定(默认1小时),不要当作永久公网地址使用。工具还会基于 DescribeEnvs 返回的 Storages[0].CdnDomain 推导 publicUrl,⚠️ 警告:publicUrl 仅在存储桶 ACL 为公有读(所有用户可读)时才能被匿名访问;默认私有读写存储桶返回的 publicUrl 会 403,此时请继续使用 temporaryUrl 或先通过控制台/SDK 将目标路径设置为公有读。

💡 存储桶 ACL 权限管理请使用 permissions 工具:queryPermissions(action="getResourcePermission", resourceType="storage", resourceId="bucket-name") 查询,managePermissions(action="updateResourcePermission", resourceType="storage", resourceId="bucket-name", permission="READONLY") 设置。

📦 CloudBase PG / pgstore 环境:DescribeEnvs.Storages[] 列出的 bucket 是旧 NoSQL 后端的,不等于 pgstore bucket。本工具用于查看常规存储;为 PG 浏览器上传准备 bucket 时,请确认目标 bucket 是 pgstore 后端可用的,否则浏览器 app.storage.from().upload(...) 会得到 STORAGE_BUCKET_NOT_FOUND 并出现 PUT https://undefined/

参数

action
string

查询操作类型:list=列出目录下的所有文件,info=获取指定文件的详细信息,url=获取文件的临时下载链接,read=读取文本文件内容 可填写的值: "list", "info", "url", "read"

cloudPath
string

云端文件路径,例如 files/data.txt 或 files/(目录)

maxAge
number

临时链接有效期,单位为秒,取值范围:1-86400,默认值:3600(1小时)


manageStorage

管理 CloudBase 云存储文件,仅用于 COS/Storage 对象,不用于静态网站托管。支持上传文件/目录、下载文件/目录、删除文件/目录等操作。删除操作需要设置force=true进行确认,防止误删除重要文件。注意:上传后返回的 temporaryUrl 是临时签名链接,1小时后过期,不要当作永久公网地址写入配置或持久化存储。工具还会基于 DescribeEnvs 返回的 Storages[0].CdnDomain 推导 publicUrl,⚠️ 警告:publicUrl 仅在存储桶 ACL 为公有读(所有用户可读)时才能被匿名访问;默认私有读写存储桶返回的 publicUrl 会 403,此时请继续使用 temporaryUrl 或先通过控制台/SDK 将目标路径设置为公有读。

💡 存储桶 ACL 权限管理请使用 permissions 工具:queryPermissions(action="getResourcePermission", resourceType="storage", resourceId="bucket-name") 查询,managePermissions(action="updateResourcePermission", resourceType="storage", resourceId="bucket-name", permission="READONLY") 设置。

📦 CloudBase PG / pgstore 桶必须先创建后使用(与 Supabase Storage 一致:upload 前 bucket 必须存在)。浏览器 SDK app.storage.from().upload(path, file) 不会自动建桶,且 path 的第一段就是 bucket 名(例如 covers/foo.png → bucket=covers);from('covers') 这个参数当前不会被拼到 path 里。如果上传时浏览器看到 STORAGE_BUCKET_NOT_FOUNDPUT https://undefined/(DevTools 表现为 net::ERR_NAME_NOT_RESOLVED),先用本工具或控制台确认 / 创建对应的 pgstore bucket,再让前端重试上传,不要让前端把上传失败静默吞掉。DescribeEnvs.Storages[] 返回的旧 NoSQL bucket(形如 &lt;hash&gt;-&lt;envId&gt;-&lt;appId&gt;)不是可用的 pgstore bucket,切勿当作默认目标使用。

参数

action
string

管理操作类型:upload=上传文件或目录,download=下载文件或目录,delete=删除文件或目录 可填写的值: "upload", "download", "delete"

localPath
string

本地文件路径,建议传入绝对路径,例如 /tmp/files/data.txt

cloudPath
string

云端文件路径,例如 files/data.txt

force
boolean

强制操作开关,删除操作时建议设置为true以确认删除,默认false

isDirectory
boolean

是否为目录操作,true=目录操作,false=文件操作,默认false


downloadTemplate

自动下载并部署CloudBase项目模板。 Note: Call this tool when the user requests to create a new project using a CloudBase template.

支持的模板:

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

支持的IDE类型:

  • all: 下载所有IDE配置
  • cursor: Cursor AI编辑器
  • 其他IDE类型见下方列表

注意:如果未传入 ide 参数且无法从环境变量检测到 IDE,将提示错误并要求传入 ide 参数

  • 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
  • kiro: Kiro AI编辑器
  • aider: Aider AI编辑器

特别说明:

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

参数

template
string

要下载的模板类型 可填写的值: "react", "vue", "miniprogram", "uniapp", "rules"

ide
string

指定要下载的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", "aider", "iflow-cli"

overwrite
boolean

是否覆盖已存在的文件,默认为false(不覆盖)


searchKnowledgeBase

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

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

⚠️ 重要:当 CloudBase skills 处于禁用状态或当前 IDE 不支持 skill 文件读取时,必须使用 searchKnowledgeBase(mode=skill, skillName=...) 来获取 CloudBase 技能文档内容,而不是尝试直接读取 skill 文件。直接读取可能返回 400 错误。示例:

  • 需要 auth-tool 指南时:searchKnowledgeBase(mode=skill, skillName=auth-tool)
  • 需要 auth-web 指南时:searchKnowledgeBase(mode=skill, skillName=auth-web)
  • 需要 cloudbase-agent 指南时:searchKnowledgeBase(mode=skill, skillName=cloudbase-agent)

固定技能文档 (skill) 查询当前支持 27 个固定文档,分别是: 文档名:ai-model-nodejs 文档介绍:"Use this skill for Node.js backend AI via @cloudbase/node-sdk (>=3.16.0) — cloud functions, CloudRun, Express, Koa, NestJS, serverless APIs, scheduled jobs, LLM proxies. Only SDK supporting image generation (ai.createImageModel + generateImage). Text models via ai.createModel with groups cloudbase, hunyuan-exp, or custom-. Model IDs (deepseek-v4-flash, deepseek-v3.2, hunyuan-2.0-instruct-20251111, glm-5, kimi-k2.6) go in the model field of generateText/streamText. MUST run two-step preflight before code — see body. Keywords: backend, 云函数, 云托管, serverless, LLM proxy, agent orchestration, generateText, streamText, generateImage, createModel, hunyuan-image, Token Credits, TokenHub, Hunyuan, DeepSeek, GLM, Kimi, MiniMax. NOT for browser/Web (use ai-model-web) or Mini Program (use ai-model-wechat)." 文档名:ai-model-web 文档介绍:"Use this skill when a browser/Web app (React, Vue, Angular, Next, Nuxt, static sites, SPAs, dashboards, AI chat UI) needs AI models via @cloudbase/js-sdk. Default routing for page/页面/Web/前端/frontend/网页/H5 AI — call directly from browser, do NOT propose a Node.js proxy. Covers generateText and streamText. Models via ai.createModel with groups cloudbase, hunyuan-exp, or custom-. Model IDs (deepseek-v4-flash, deepseek-v3.2, hunyuan-2.0-instruct-20251111, glm-5, kimi-k2.6) go in the model field. MUST run two-step preflight before code — see body. Keywords: 页面, Web, 前端, React, Vue, Next, Nuxt, SPA, AI chat UI, generateText, streamText, createModel, hunyuan-exp, Token Credits, TokenHub, Hunyuan, DeepSeek, GLM, Kimi, MiniMax. NOT for Node.js backend (use ai-model-nodejs), Mini Program (use ai-model-wechat), or image generation (Node SDK only)." 文档名:ai-model-wechat 文档介绍:"Use this skill for WeChat Mini Program AI via wx.cloud.extend.AI (小程序, 企业微信小程序, wx.cloud apps). Features generateText and streamText with callbacks (onText, onEvent, onFinish). Models via wx.cloud.extend.AI.createModel with groups hunyuan-exp (小程序成长计划), cloudbase (main managed), or custom-*. Model IDs (deepseek-v4-flash, deepseek-v3.2, hunyuan-2.0-instruct-20251111, glm-5, kimi-k2.6) go in the data wrapper model field. API differs from JS/Node SDK — streamText needs data wrapper, generateText returns raw response. MUST run two-step preflight before code — see body. Keywords: Mini Program AI, wx.cloud.extend.AI, 小程序成长计划, ai_miniprogram_inspire_plan, Token Credits 资源包, generateText, streamText, createModel, hunyuan-exp, TokenHub, Hunyuan, DeepSeek, GLM, Kimi, MiniMax. NOT for browser/Web (use ai-model-web), Node.js backend (use ai-model-nodejs), or image generation (use ai-model-nodejs)." 文档名:auth-nodejs 文档介绍: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. 文档名:auth-tool 文档介绍: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. 文档名:auth-web 文档介绍: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. 文档名:auth-wechat 文档介绍: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. 文档名:cloud-functions 文档介绍: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. 文档名:cloud-storage-web 文档介绍:Complete guide for CloudBase cloud storage using Web SDK (@cloudbase/js-sdk) - upload, download, temporary URLs, file management, and best practices. 文档名:cloudbase-agent 文档介绍: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). 文档名:cloudbase-cli 文档介绍:CloudBase CLI (tcb, 云开发CLI, Tencent CloudBase命令行) resource management skill. This skill should be used when users need to deploy cloud functions, manage CloudRun apps, upload files to storage, query NoSQL/MySQL databases, deploy static hosting, set access permissions, or configure CORS/domains/routing via tcb commands. Also use for CI/CD pipeline scripting, batch operations, terminal-based CloudBase management, or when the user prefers CLI over SDK/MCP. 文档名:cloudbase-code-review 文档介绍:"Code review and validation for CloudBase projects. After writing code for Web / miniprogram / CloudRun / cloud-function projects, call this skill to check for known pitfalls — auth guard misuse, missing database tables, RLS misconfiguration, storage domain setup, and SDK API misuse. Supports automated lint scripts (regex-based) + LLM semantic review." 文档名:cloudbase-platform 文档介绍: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. 文档名:cloudbase-wechat-integration 文档介绍:CloudBase WeChat integration guide for Mini Program WeChat Pay, Official Account JSAPI Pay, Native QR-code Pay, Official Account OAuth, openid handling, payment callbacks, and CloudBase Integration Center generated functions. This skill should be used when users ask to add, debug, or extend WeChat payment or official-account flows on CloudBase. 文档名: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 MySQL table creation, use relational-database-tool directly; for PostgreSQL / CloudBase PG schema work, use postgresql-development. 文档名:http-api 文档介绍: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. 文档名:miniprogram-development 文档介绍: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, tabBar, routing, navigation, icon assets, 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. 文档名:no-sql-web-sdk 文档介绍:Use CloudBase document database Web SDK only for confirmed NoSQL collection work. Query, create, update, and delete document data; if the task mentions PostgreSQL / CloudBase PG / app.rdb(), route to postgresql-development instead. 文档名: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. 文档名:ops-inspector 文档介绍: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. 文档名:postgresql-development 文档介绍:"Use when building, debugging, or evaluating CloudBase PostgreSQL / CloudBase PG / PG mode apps, including Postgres schema setup, queryPgDatabase/managePgDatabase, JS SDK v3 app.rdb() CRUD/RPC, PG HTTP API fallback, RLS-style permissions, username-password auth, and Web CMS/admin CRUD flows backed by CloudBase PG." 文档名:relational-database-tool 文档介绍: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. 文档名: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 文档介绍: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. 文档名:ui-design 文档介绍:Use when users need visual direction, interface hierarchy, layout decisions, design specifications, or prototypes before implementing a Web or mini program UI. 文档名:web-development 文档介绍: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 文档 (openapi) 查询只需要传 mode="openapi" 和 apiName,不要传 action;action 仅用于 mode="docs"。当前支持 7 个 API 文档,分别是: API名:mysqldb API介绍:关系型数据库 RESTful API (MySQL/PostgreSQL) - 云开发关系型数据库 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 API名:nosql API介绍:NoSQL RESTful API - 文档型数据库 HTTP API API名:ai_model API介绍:AI 大模型接入 API - 统一 AI 模型 HTTP API

参数

mode
string

可填写的值: "vector", "skill", "openapi", "docs"

skillName
string

mode=skill 时指定。技能名称。 可填写的值: "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-cli", "cloudbase-code-review", "cloudbase-platform", "cloudbase-wechat-integration", "cloudrun-development", "data-model-creation", "http-api", "miniprogram-development", "no-sql-web-sdk", "no-sql-wx-mp-sdk", "ops-inspector", "postgresql-development", "relational-database-tool", "relational-database-web", "spec-workflow", "ui-design", "web-development"

apiName
string

mode=openapi 时指定。API 名称。 可填写的值: "mysqldb", "functions", "auth", "cloudrun", "storage", "nosql", "ai_model"

action
string

仅 mode=docs 时指定;mode=openapi 不要传 action。CloudBase 文档操作类型:listModules=列出所有文档模块,listModuleDocs=获取指定模块的目录结构,findByName=按名称/路径/URL 智能查找,readDoc=读取指定文档 Markdown,searchDocs=全文搜索官方文档。 可填写的值: "listModules", "listModuleDocs", "findByName", "readDoc", "searchDocs"

moduleName
string

mode=docs 且 action=listModuleDocs 时指定。模块名称。

input
string

mode=docs 且 action=findByName 时指定。支持模块名、文档标题、层级路径或 URL。

docPath
string

mode=docs 且 action=readDoc 时指定。文档相对路径或完整 URL。

query
string

mode=docs 且 action=searchDocs 时指定。全文检索关键词。

threshold
number

mode=vector 时指定。相似性检索阈值

id
string

mode=vector 时指定。知识库范围,默认 cloudbase。cloudbase=云开发全量知识,scf=云开发的云函数知识, miniprogram=小程序知识(不包含云开发与云函数知识) 可填写的值: "cloudbase", "scf", "miniprogram"

content
string

mode=vector 时指定。检索内容

options
object

mode=vector 时指定。其他选项

limit
number

mode=vector 时指定。指定返回最相似的 Top K 的 K 的值


queryCloudRun

查询云托管服务信息,支持获取服务列表、查询服务详情、获取可用模板列表和部署日志。返回的服务信息包括服务名称、状态、访问类型、配置详情以及最近部署上下文。

参数

action
string

查询操作类型:list=获取云托管服务列表(支持分页和筛选),detail=查询指定服务的详细信息(包含服务配置和最新部署状态),templates=获取可用的项目模板列表(用于初始化新项目),getDeployLog=获取指定服务最近一次或指定构建的部署日志 可填写的值: "list", "detail", "templates", "getDeployLog"

pageSize
number

分页大小,控制每页返回的服务数量。取值范围:1-100,默认值:10。建议根据网络性能和显示需求调整

pageNum
number

页码,用于分页查询。从1开始,默认值:1。配合pageSize使用可实现分页浏览

serverName
string

服务名称筛选条件,支持模糊匹配。例如:输入"test"可匹配"test-service"、"my-test-app"等服务名称。留空则查询所有服务

serverType
string

服务类型筛选条件:function=函数型云托管(仅支持Node.js,有特殊的开发要求和限制,适合简单的API服务),container=容器型服务(推荐使用,支持任意语言和框架如Java/Go/Python/PHP/.NET等,适合大多数应用场景) 可填写的值: "function", "container"

detailServerName
string

要查询详细信息或部署日志的服务名称。当action为detail或getDeployLog时建议提供,必须是已存在的服务名称。可通过list操作获取可用的服务名称列表

buildId
number

构建ID,仅在action=getDeployLog时使用。不传时默认返回最近一次部署的构建日志


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

服务配置项,用于部署时设置服务的运行参数。包括资源规格、访问权限、环境变量等配置。不提供时使用默认配置

template
string

项目模板标识符,用于指定初始化项目时使用的模板。可通过queryCloudRun的templates操作获取可用模板列表。常用模板:helloworld=Hello World示例,nodejs=Node.js项目模板,python=Python项目模板等

runOptions
object

本地运行参数配置,仅函数型云托管服务支持。用于配置本地开发环境的运行参数,不影响云端部署

agentConfig
object

Agent配置项,仅在createAgent操作时使用

force
boolean

强制操作开关,用于跳过确认提示。默认false(需要确认),设置为true时跳过所有确认步骤。删除操作时强烈建议设置为true以避免误操作

serverType
string

服务类型配置:function=函数型云托管(仅支持Node.js,有特殊的开发要求和限制,适合简单的API服务),container=容器型服务(推荐使用,支持任意语言和框架如Java/Go/Python/PHP/.NET等,适合大多数应用场景)。不提供时自动检测:1)现有服务类型 2)有Dockerfile→container 3)有@cloudbase/aiagent-framework依赖→function 4)其他情况→container 可填写的值: "function", "container"


queryGateway

CloudBase 网关统一只读入口。通过 action 查询网关域名、访问入口和目标暴露情况。

参数

action
string

只读操作类型,例如 getAccess、listDomains 可填写的值: "getAccess", "listDomains", "listRoutes", "getRoute", "listCustomDomains"

targetType
string

目标资源类型。当前支持 function,后续可扩展 可填写的值: "function"

targetName
string

目标资源名称。getAccess 时必填

routeId
string

路由 ID。getRoute 时可选


manageGateway

CloudBase 网关统一写入口。通过 action 创建目标访问入口,后续承接更通用的网关配置能力。为已存在的 HTTP 云函数补默认域名访问时,通常使用 createAccess 并提供 targetType="function"、targetName、type="HTTP" 与期望 path。注意 createAccess 只创建网关入口,不会自动修改函数资源权限。⚠️ 如需绑定带 SSL 证书的自定义域名供公网 HTTPS 访问,使用 action="bindCustomDomain"(需要 domain 和 certificateId 参数);如需配置 CORS/安全域名(无证书),请使用 envDomainManagement 工具。

参数

action
string

写操作类型,例如 createAccess。为已有函数补默认域名访问入口时使用 createAccess;若 action=createAccess 且 targetType=function,必须显式提供 type。 可填写的值: "createAccess", "createRoute", "updateRoute", "deleteRoute", "bindCustomDomain", "deleteCustomDomain", "deleteAccess", "updatePathAuth"

targetType
string

目标资源类型。当前支持 function,后续可扩展 可填写的值: "function"

targetName
string

目标资源名称。createAccess 到云函数时填写函数名

path
string

访问路径,默认 /{targetName}。例如为 HTTP 函数暴露 /api/hello 时传 /api/hello。该参数只创建网关入口,不会自动放开函数资源权限。

type
string

目标函数的运行时类型,不是接入协议。createAccess 到已创建的 HTTP 云函数时传 HTTP;给 Event 函数补网关访问时传 Event 或省略。省略会默认按 Event 路由处理,可能让 HTTP 云函数访问后返回 FUNCTION_PARAM_INVALID。 可填写的值: "Event", "HTTP"

auth
boolean

是否开启网关路径鉴权。若要走默认域名做匿名或浏览器访问,通常设为 false;该开关仅控制网关入口本身,不会修改函数资源权限,仍需检查并按需调整函数安全规则。

route
object

HTTP 路由配置对象

domain
string

自定义域名

certificateId
string

证书 ID

accessName
string

访问入口名称,保留字段

accessId
string

访问入口 ID。deleteAccess 时可直接传入,避免参数歧义


queryAppAuth

CloudBase 应用侧认证配置只读入口。用于查询登录方式、provider、publishable key、API key、client 配置和静态域名等认证准备状态。⚠️ 本工具为管理端配置查询工具,不执行用户登录。当任务要求编写客户端登录代码时(例如「用 JS SDK 登录」),应先通过本工具确认配置状态,再在项目代码中编写 @cloudbase/js-sdk 客户端登录代码(如 auth.signInWithPassword()),而非使用本工具完成登录。若业务要接受普通用户名样式标识符,先查询 action=getLoginConfig;若 usernamePassword=false,下一步应立即调用 manageAppAuth(action=patchLoginStrategy, patch={ usernamePassword: true }),不要直接写 email 登录 API。

参数

action
string

可填写的值: "getLoginConfig", "listProviders", "getProvider", "getClientConfig", "getPublishableKey", "getStaticDomain", "listApiKeys"

providerId
string

provider 标识,如 email、google

clientId
string

OAuth client_id / DescribeClient 的 Id;省略时默认使用当前环境 ID(默认客户端)

keyType
string

API key 类型过滤,可选 publish_key 或 api_key 可填写的值: "publish_key", "api_key"

pageNumber
integer

API key 列表页码,从 1 开始

pageSize
integer

API key 列表每页条数


manageAppAuth

CloudBase 应用侧认证配置写入口。用于修改登录方式、provider、client 配置,确保 publishable key,以及创建或删除 API key、自定义登录密钥。⚠️ 本工具为管理端配置工具,不执行用户登录。当任务要求编写客户端登录代码时(例如「用 JS SDK 登录」),应先通过本工具完成配置(如启用 usernamePassword、获取 publishable key),再在项目代码中编写 @cloudbase/js-sdk 客户端登录代码(如 auth.signInWithPassword()),而非使用本工具完成登录。若前端要接受普通用户名样式标识符,应先执行 action=patchLoginStrategy 并传入 patch={ usernamePassword: true },再实现对应前端登录逻辑。

参数

action
string

可填写的值: "patchLoginStrategy", "addProvider", "updateProvider", "deleteProvider", "updateClientConfig", "ensurePublishableKey", "createApiKey", "deleteApiKey", "createCustomLoginKeys"

patch
object

patchLoginStrategy 使用的简化登录策略 patch,如 { usernamePassword: true }

providerId
string

provider 标识,如 email、google;addProvider 时也可作为自定义 provider Id

providerType
string

addProvider 时的 provider 协议类型 可填写的值: "OAUTH", "OIDC", "SAML", "WX_MICRO_APP", "WX_QRCODE_MICRO_APP", "WX_CLOUDBASE_MICRO_APP", "WX_MP", "WX_OPEN", "WX_WORK_INTERNAL", "WX_WORK_AGENT", "WX_WORK_THIRD_PARTY", "WX_WORK_THIRD_PARTY_ASSOCIATION", "CUSTOM", "EMAIL"

displayName
union

addProvider 时的展示名称,可传字符串或多语言对象

clientId
string

updateClientConfig 时的客户端 Id;省略时默认使用当前环境 ID

config
object

provider / client 的配置对象

keyType
string

createApiKey 时的 API key 类型,默认 publish_key 可填写的值: "publish_key", "api_key"

keyName
string

createApiKey 时的 API key 名称

expireIn
integer

createApiKey 时的有效期,单位秒;0 表示不过期

keyId
string

deleteApiKey 时的 API key 唯一标识


queryApps

查询 CloudBase 应用部署的应用和版本。可查应用列表/详情、版本列表/详情;部署后用 getAppVersion 按 buildId 轮询构建状态;getBuildLog 可查询构建日志用于诊断失败原因。

参数

action
string

可填写的值: "listApps", "getApp", "listAppVersions", "getAppVersion", "getBuildLog"

serviceName
string

CloudBase 应用服务名。getApp / listAppVersions / getAppVersion / getBuildLog 时必填;重新部署后复用同一个 serviceName 查询版本历史。

searchKey
string

按应用服务名模糊搜索关键词,仅 action=listApps 时使用。

pageNo
number

分页页码,从 1 开始。

pageSize
number

分页大小。

versionName
string

版本名称。getAppVersion 时可与 buildId 二选一;已知版本号时优先传该值。

buildId
string

构建 ID。getAppVersion 时可与 versionName 二选一;部署返回 BuildId 后可直接用它轮询状态。getBuildLog 时必填。

start
number

构建日志偏移量,用于分页拉取后续日志。仅 action=getBuildLog 时使用,不传时从开头返回。


manageApps

部署 Web 应用到 CloudBase(构建前后端,部署到独立子域名)。 action=getUploadUrl 获取预签名上传 URL(cloud mode 下使用),返回上传地址和 cosTimestamp。 action=deployApp 上传源码 ZIP 并触发远端构建部署管道:

  1. 远端 npm install(可通过 installCmd="" 跳过)
  2. 远端 npm run build(可通过 buildCmd="" 跳过)
  3. 远端 tcb hosting deploy

域名格式:&lt;serviceName&gt;-&lt;envId&gt;.webapps.tcloudbase.com(每个 serviceName 一个独立子域名)

✅ 推荐用法(新项目/需要独立域名的 Web 应用,首选此工具): 新建项目首次部署时,传 framework=static, installCmd="", buildCmd="" 跳过远端构建, 只执行 tcb hosting deploy。部署后获得独立子域名,支持版本管理。

⚠️ 兼容性说明:

  • 已有项目若之前用 manageHosting 部署过(域名格式:&lt;envId&gt;-&lt;appId&gt;.tcloudbaseapp.com), 切换到 manageApps 会产生全新的 URL,老链接失效。请保持原部署方式不变。
  • 如需判断:调用 queryHosting 检查是否已有托管文件。

与 manageHosting 对比:

  • manageApps(本工具,新项目首选):域名 &lt;serviceName&gt;-&lt;envId&gt;.webapps.tcloudbase.com,独立子域名,支持版本管理
  • manageHosting(已有项目或 fallback):域名 &lt;envId&gt;-&lt;appId&gt;.tcloudbaseapp.com/&lt;path&gt;,共享环境域名 两者均可绑定自定义域名。

⚠️ 如果 manageApps 构建失败,先用 queryApps(action="getBuildLog") 查日志;仍不行再 fallback 到 manageHosting。

参数

action
string

可填写的值: "deployApp", "getUploadUrl", "deleteApp", "deleteAppVersion"

serviceName
string

CloudBase 应用服务名,会体现在域名中:`<serviceName>-<envId>.webapps.tcloudbase.com`。deployApp 时复用现有 serviceName 会新增一个部署版本并触发重新部署,而不是删除重建。首次部署请用新名称。

filePath
string

要上传并部署的本地项目根目录绝对路径。本地模式下 deployApp 时必填;通常传源码所在目录(含 package.json 和源码),不是 dist 目录。构建产物目录请用 buildPath 指定。cloud mode 下无需传此参数,改用 cosTimestamp。

cosTimestamp
string

可选 COS 时间戳。传入此值则直接使用已上传的代码创建应用,跳过本地文件上传。需先调用 getUploadUrl 获取预签名 URL,上传 ZIP 包后再传此时间戳。cloud mode 下为必填;本地模式也可传此值代替 filePath。两个路径二选一:filePath(本地打包上传)或 cosTimestamp(预签名 URL 上传)。

appPath
string

应用线上访问路径(hosting mount path),例如 /my-web-app。不是本地目录路径;CloudApp 已有独立子域名,省略时默认为 /(根路径)。

buildPath
string

构建产物目录,相对于 filePath,例如 dist 或 build。 ⚠️ 传此值后远端构建系统会 cd 到此目录再执行 tcb hosting deploy,因此 deployCmd 会自动使用 .(当前目录)而非目录名,避免路径重复(如 dist/dist 错误)。 纯静态 HTML 如果在项目根目录可省略,但注意 deployCmd 默认用 dist。

framework
string

前端框架类型。可选值:vue、react、next、nuxt、vite、angular、static。 即使传 static,仍会经过远端构建管道。如果本地已构建好,建议改用 manageHosting 直接上传,可完全跳过远端构建。 可填写的值: "vue", "react", "next", "nuxt", "vite", "angular", "static"

nodeJsVersion
string

构建时使用的 Node.js 版本;不传时由 CloudBase 使用默认值。

installCmd
string

依赖安装命令,例如 npm install。不传时默认 npm install。本地已安装或无需安装可传空字符串 '' 跳过,但远端仍会执行 tcb hosting deploy。

buildCmd
string

构建命令,例如 npm run build。不传时默认 npm run build。本地已构建好可传空字符串 '' 跳过构建步骤。若希望完全跳过远端管道,请改用 manageHosting。

deployCmd
string

自定义部署命令。通常无需填写,默认自动生成 tcb hosting deploy 命令。有 buildPath 时远端已 cd 到该目录,默认用 . 作为源码路径;无 buildPath 时默认用 dist。

ignore
array of string

上传时忽略的文件/目录 glob 模式,例如 **/node_modules/**。

versionName
string

要删除的历史版本名,仅 action=deleteAppVersion 时必填。


queryPermissions

查询 CloudBase 权限与用户配置,支持查询资源权限(数据库/云函数/存储桶等)、角色列表/详情、应用用户列表/详情。

示例:

  • 查询存储桶权限:action="getResourcePermission", resourceType="storage", resourceId="bucket-name"

📌 跨后端边界提示:调用前先用 envQuery(action="info", envId=...)EnvInfo.RuntimeBackendsresourceType="noSqlDatabase" 查询的是 CloudBase NoSQL 集合规则,与 CloudBase PostgreSQL(PG)表的行级安全(RLS)是两套独立机制——同一个 PG 环境里 NoSQL 集合若仍在使用,对那些集合查询本工具结果仍然有效。要查 PG 表 RLS,请改用 queryPgDatabase(action="sql", sql="SELECT * FROM pg_policies WHERE tablename=...")。本工具不涉及 MySQL 权限。

参数

action
string

可填写的值: "getResourcePermission", "listResourcePermissions", "listRoles", "getRole", "listUsers", "getUser"

resourceType
string

可填写的值: "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

管理 CloudBase 权限与用户配置,支持修改资源权限(数据库/云函数/存储桶等)、角色管理、成员与策略增删、应用用户 CRUD。

示例:

  • 设置存储桶为私有:action="updateResourcePermission", resourceType="storage", resourceId="bucket-name", permission="PRIVATE"
  • 创建角色:action="createRole", roleName="admin", roleIdentity="admin"

注意:createUser / updateUser 是环境侧应用用户管理能力,适合测试账号、管理员或预置用户,不应替代浏览器里的 Web SDK 注册表单;前端用户名密码注册应使用 auth.signUp(\{ username, password \}),登录应使用 auth.signInWithPassword(\{ username, password \})。直接在浏览器里用 auth.signUp 创建用户名密码用户取决于 SDK/provider 支持,使用前必须验证;不支持时应走后端或管理端边界,不能在浏览器暴露密钥。securityRule 的详细语义取决于 resourceTypedoc._openidauth.openid、查询条件子集校验,以及 create / update / delete JSON 模板仅适用于 resourceType="noSqlDatabase" 的文档数据库安全规则;配置 functionstorage 时,请参考各自官方安全规则文档,而不是复用 NoSQL 模板。

📌 跨后端边界提示:调用前先用 envQuery(action="info", envId=...)EnvInfo.RuntimeBackends

  • resourceType="noSqlDatabase" 仅作用于 CloudBase NoSQL 文档数据库的集合;CloudBase PostgreSQL(PG)表的行级权限受它控制——PG 表请改用 RLS:managePgDatabase(action="execute", confirm=true)ALTER TABLE ... ENABLE ROW LEVEL SECURITYCREATE POLICY ...。同一个 PG 环境里如果还有 NoSQL 集合在用,对那些集合继续使用 noSqlDatabase 规则是正确的——不是"PG 环境就禁用本工具"。
  • resourceType="storage" 控制的是 NoSQL/COS 存储桶 ACL;PG 的 pgstore bucket 不在此 resourceType 覆盖范围内。
  • 本工具不涉及 MySQL;MySQL 数据库权限请走 MySQL 自身的 GRANT/REVOKE 语句(通过 manageSqlDatabase)。

参数

action
string

可填写的值: "updateResourcePermission", "createRole", "updateRole", "deleteRoles", "addRoleMembers", "removeRoleMembers", "addRolePolicies", "removeRolePolicies", "createUser", "updateUser", "deleteUsers"

resourceType
string

目标资源类型。`securityRule` 的具体语义依赖这个值;`noSqlDatabase` 使用集合安全规则,`function` 与 `storage` 也有各自独立的安全规则语义,不要套用 NoSQL 规则语法。 可填写的值: "noSqlDatabase", "sqlDatabase", "function", "storage"

resourceId
string
permission
string

可填写的值: "READONLY", "PRIVATE", "ADMINWRITE", "ADMINONLY", "CUSTOM"

securityRule
string

资源类型特定的规则内容,详细语义依赖 `resourceType`。当 `resourceType="noSqlDatabase"` 且 `permission="CUSTOM"` 时,应传文档数据库安全规则 JSON(文档型数据库规则:`https://docs.cloudbase.net/database/security-rules`);键通常为 `read` / `create` / `update` / `delete`,值为表达式。重要:`create` 规则验证写入数据,此时文档尚不存在,不能使用 `doc.*`;`read` / `update` / `delete` 规则可使用 `doc.*` 引用已有文档字段。不要把 `doc._openid`、`auth.openid`、查询条件子集校验或 `create` / `update` / `delete` 模板误用于 `function`、`storage` 或 `sqlDatabase`。如需配置 `function` 或 `storage`,请改查官方安全规则文档:云函数 `https://docs.cloudbase.net/cloud-function/security-rules`,云存储 `https://docs.cloudbase.net/storage/security-rules`。示例:{"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

角色标识符(字母/数字/_-:@.),action=createRole 时必填,用于程序化引用角色

description
string
memberUids
array of string
policies
array of object
policyIds
array of string

策略 ID 列表(当前不支持直接按 ID 绑定,请改传 policies 详情对象)

uid
string
uids
array of string
username
string
password
string
userStatus
string

可填写的值: "ACTIVE", "BLOCKED"


queryLogs

CloudBase 日志域统一只读入口。支持检查日志服务状态并搜索 CLS 日志。

重要区分

  • 查询云函数日志:使用 queryFunctions(action="listFunctionLogs", functionName="xxx")
  • 查询 CLS 日志(跨服务日志聚合):使用本工具 queryLogs(action="searchLogs")

适用场景

  • 检查 CLS 日志服务是否开通:action="checkLogService"
  • 跨服务日志搜索(如搜索所有 ERROR 日志):action="searchLogs"
  • 按 CLS 语法检索特定服务的日志:action="searchLogs", service="tcb|tcbr"

参数

action
string

操作类型: - `checkLogService`: 检查 CLS 日志服务是否开通 - `searchLogs`: 搜索 CLS 日志(需要提供 queryString) 可填写的值: "checkLogService", "searchLogs"

queryString
string

CLS 查询语句,**action="searchLogs" 时必填**,需严格遵循 CLS(Cloud Log Service)语法规范,详见 https://cloud.tencent.com/document/api/876/128127 **云函数相关查询**: - 云函数日志:`(src:app OR src:system) AND log:"START RequestId"` - 聚合云函数请求状态:`| select request_id, max(status_code) as status where ((request_id='44738f94-16dd-11f1-****' AND retry_num=0) AND retry_num=0) AND status_code!=202 group by request_id, retry_num` **云数据库 / 文档型**: - 云数据库(文档型):`module:database` - 云数据库(文档型)事件:`module:database AND eventType:(MongoSlowQuery)`(MongoSlowQuery 为文档型数据库慢查询事件) **云数据库 / SQL 型**: - 云数据库(SQL 型):`module:rdb` - 云数据库(SQL 型)事件:`module:rdb AND eventType:(MysqlFreeze OR MysqlRecover OR MysqlSlowQuery)`(MysqlFreeze 冻结、MysqlRecover 恢复、MysqlSlowQuery 慢查询) **其它服务**: - 审批流:`module:workflow` - 模型:`module:model` - 用户权限:`module:auth` - 大模型:`module:llm AND logType:llm-tracelog` - 网关服务调用:`logType:accesslog` - 应用发布/删除事件:`module:app AND eventType:(AppProdPub OR AppProdDel)`(AppProdPub 发布事件、AppProdDel 删除事件) 以上仅为示例,实际使用时请根据具体日志内容调整。 **注意**:查询特定云函数的执行日志时,优先使用 `queryFunctions(action="listFunctionLogs", functionName="xxx")`。

service
string

日志来源服务: - `tcb`: 云函数、数据库、存储等基础服务日志 - `tcbr`: CloudRun 容器服务日志 可填写的值: "tcb", "tcbr"

startTime
string

查询开始时间,格式:`YYYY-MM-DD HH:mm:ss`,如 `2024-01-01 00:00:00`

endTime
string

查询结束时间,格式:`YYYY-MM-DD HH:mm:ss`,如 `2024-01-01 23:59:59`

limit
number

返回日志条数限制,默认 20

context
string

翻页上下文,用于继续上一次查询

sort
string

按时间排序:`asc` 升序,`desc` 降序 可填写的值: "asc", "desc"


queryAgents

CloudBase Agent 域统一只读入口。支持列表、详情与日志查询。

参数

action
string

可填写的值: "listAgents", "getAgent", "getAgentLogs"

agentId
string
pageNumber
number
pageSize
number
params
object

manageAgents

CloudBase Agent 域统一写入口。支持创建、更新和删除远端 Agent。

参数

action
string

可填写的值: "createAgent", "updateAgent", "deleteAgent"

agentId
string
name
string
description
string
runtime
string
timeout
number
memorySize
number
installDependency
boolean
zipFile
string
cosBucketRegion
string
tempCosObjectName
string
sessionConfig
object
cwd
string
params
object

downloadRemoteFile

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

参数

url
string

远程文件的 URL 地址

relativePath
string

相对于项目根目录的路径,例如:'assets/images/logo.png' 或 'docs/api.md'。不允许使用 ../ 等路径遍历操作。


activateInviteCode

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

参数

InviteCode
string

待激活的邀请码


callCloudApi

通用的云 API 调用工具,主要用于 CloudBase / 腾讯云管控面与依赖资源相关 API 调用。调用前请先确认 service、Action 与 Param,避免猜测 Action 名称。如果你的目标是通过 HTTP 协议直接集成 auth/functions/cloudrun/storage/mysqldb 等 CloudBase 业务 API,请不要优先使用 callCloudApi,而应优先查看对应 OpenAPI / Swagger。现有 OpenAPI / Swagger 能力不是通用的管控面 Action 集合;管控面 API 请优先参考 CloudBase API 概览 https://cloud.tencent.com/document/product/876/34809 与云开发依赖资源接口指引 https://cloud.tencent.com/document/product/876/34808。对于 tcb service,常用 Action 分类如下:

环境管理: CreateEnvModifyEnvDescribeEnvsDestroyEnv 用户管理: CreateUserModifyUserDescribeUserListDeleteUsers 认证配置: EditAuthConfigDescribeAuthDomains 云函数: DescribeFunctionsCreateFunctionUpdateFunctionCodeDeleteFunction 数据库: CreateMySQLInstanceDescribeMySQLInstancesDestroyMySQLInstance

销毁环境时,常见做法是至少带上 EnvIdBypassCheck: true,如果环境已经处于隔离期再按文档补 IsForce: true

参数

service
string

选择要访问的服务。可选:tcb、scf、sts、cam、lowcode、cdn、vpc。对于 tcb / scf / lowcode 等 CloudBase 管控面 Action,请优先查官方文档,不要直接猜测 Action。 可填写的值: "tcb", "scf", "sts", "cam", "lowcode", "cdn", "vpc"

action
string

具体 Action 名称,需符合对应服务的官方 API 定义。若不确定正确 Action,请先查官方文档;不要用近义词或历史命名进行猜测。tcb 常用 Action:环境管理 CreateEnv/ModifyEnv/DescribeEnvs/DestroyEnv、用户管理 CreateUser/ModifyUser/DescribeUserList/DeleteUsers、认证配置 EditAuthConfig、云函数 DescribeFunctions/CreateFunction、数据库 CreateMySQLInstance 等。

params
object

Action 对应的参数对象,键名需与官方 API 定义一致。某些 Action 需要携带 EnvId 等信息;如不确定参数结构,请先查官方文档。tcb 示例:`{ "service": "tcb", "action": "DestroyEnv", "params": { "EnvId": "env-xxx", "BypassCheck": true } }`,如果环境已经处于隔离期,可再补 `IsForce: true`;更新环境别名则可用 `{ "service": "tcb", "action": "ModifyEnv", "params": { "EnvId": "env-xxx", "Alias": "demo" } }`。若你的场景是通过 HTTP 协议直接集成 auth/functions/cloudrun/storage/mysqldb 等 CloudBase 业务 API,请优先使用 OpenAPI / Swagger 或 searchKnowledgeBase(mode="openapi"),而不是优先使用 callCloudApi。