Model Context Protocolを介して、データベース、関数、ストレージ、ホスティングを含むTencent CloudBase環境を操作します。
別名 TencentCloudBase/CloudBase-AI-Toolkit, cloudbase-mcp, @cloudbase/cloudbase-mcp
- スター
- 1,165
- ツール
- 42
- ダウンロード数(30日間)
- 190,812
- 最新バージョン
- 2.37.7
- 最終コミット
- 2026年11月15日
- ライセンス
- MIT
CloudBase MCPとは
Model Context Protocolを介して、データベース、関数、ストレージ、ホスティングを含むTencent CloudBase環境を操作します。 42個のツールを提供しており、auth, queryEnv, envDomainManagementなどがあります。
プロジェクトのREADMEから生成された概要
CloudBase MCP server について
CloudBaseは、Model Context Protocolを使用して、AIコーディングツールからTencent CloudBase環境を直接管理する方法を提供します。これにより、開発者はデータベース、クラウド関数、ストレージ、ホスティングなどのクラウドリソースとやり取りできます。このサーバーは、npxによるローカル実行と、中国国内または海外サイト向けのHTTPエンドポイントを介したリモート接続モードの両方をサポートしています。
ユーザーは、ブラウザベースの簡単な認可を行う対話的なOAuth、または自動化されたCI/CDワークフロー用の静的な認証情報のいずれかを使用して接続できます。ローカルモードでは、ローカルファイルシステムのアップロードやテンプレートのダウンロードを含むすべての機能が利用可能であり、リモートモードは速度とセキュリティに最適化されています。また、破壊的な操作に対する特定の確認ダイアログや、機密性の高いキーを書き込む際の誤入力による事故を防ぐための認証情報ガードなど、安全メカニズムを備えています。
できること
- 1フルスタックアプリケーションのデプロイデータベースと権限を備えたToDoアプリを構築し、それをクラウドにデプロイするようAIに指示します。
- 2CI/CDによるクラウドインフラの自動化静的な認証情報を使用して、ブラウザ操作なしで自動化されたクライアントが環境を管理できるようにします。
プロジェクトの README から作成されています。すべてのユースケースは、その引用と照らし合わせて確認されています。
CloudBase MCPのインストール方法
フォーマット検証日 2026年11月10日Cursor に追加Gooseに追加Claude CodeにCloudBase MCPをインストール
$ claude mcp add cloudbase-mcp -- npx -y @cloudbase/cloudbase-mcpCursorにCloudBase MCPをインストール
~/.cursor/mcp.json
{
"mcpServers": {
"cloudbase-mcp": {
"command": "npx",
"args": [
"-y",
"@cloudbase/cloudbase-mcp"
]
}
}
}VS CodeにCloudBase MCPをインストール
.vscode/mcp.json
{
"servers": {
"cloudbase-mcp": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@cloudbase/cloudbase-mcp"
]
}
}
}VS Code CLIにCloudBase MCPをインストール
$ code --add-mcp '{"name":"cloudbase-mcp","type":"stdio","command":"npx","args":["-y","@cloudbase/cloudbase-mcp"]}'Claude DesktopにCloudBase MCPをインストール
claude_desktop_config.json
{
"mcpServers": {
"cloudbase-mcp": {
"command": "npx",
"args": [
"-y",
"@cloudbase/cloudbase-mcp"
]
}
}
}CodexにCloudBase MCPをインストール
$ codex mcp add cloudbase-mcp -- npx -y @cloudbase/cloudbase-mcpCodex config.tomlにCloudBase MCPをインストール
~/.codex/config.toml
[mcp_servers.cloudbase-mcp] command = "npx" args = ["-y", "@cloudbase/cloudbase-mcp"]
Gemini CLIにCloudBase MCPをインストール
$ gemini mcp add -s user cloudbase-mcp npx -- -y @cloudbase/cloudbase-mcpGemini settings.jsonにCloudBase MCPをインストール
~/.gemini/settings.json
{
"mcpServers": {
"cloudbase-mcp": {
"command": "npx",
"args": [
"-y",
"@cloudbase/cloudbase-mcp"
]
}
}
}HostedMCP が 2026年11月16日 に起動を確認
@cloudbase/cloudbase-mcp 2.37.7 をネットワークもキーもない隔離コンテナでこのコマンドで起動しました。応答があり、42個のツールが一覧表示されました。
CloudBase MCPツール 42
tools/list でサーバーから取得authアクションCloudBase(腾讯云开发)开发阶段登录与环境绑定。不确定该从哪开始?先调一次 auth(status)(只读、不用参数),确认登录态和当前环境。登录后即可访问云资源;环境(env)是云函数、数据库、静态托管等资源的隔离单元,绑定环境后其他 MCP 工具才能操作该环境。还没有环境时:国内站新用户可以免费开通一个体验环境,开通后再用 set_env 绑定。支持:查询状态、发起登录、API Key登录、绑定环境(set_env)、退出登录。auth(status) 会返回 credential_scope(account=账号级 / single_env=环境级 API Key)与当前 region;环境级 API Key 只能看到绑定的 envId,查不到其他地域环境是权限边界而非环境不存在。可选 site/region/lang 参数:site=站点(domestic/intl),region=地域,lang=输出语言(zh/en)。
queryEnv読み取り専用查询 CloudBase 环境相关信息,支持查询环境列表、指定环境详情、安全域名、资源用量与监控指标。(曾用名:envQuery、listEnvs、getEnvInfo、getEnvAuthDomains)当 action=list 时,会按 DescribeEnvs 语义做列表/筛选,标准返回字段为 EnvId、Alias、Status、EnvType、Region、PackageId、PackageName、IsDefault,并支持通过 fields 白名单裁剪这些字段;aliasExact=true 时会按别名精确筛选,避免把前缀相近的环境误当作候选;即使传入 envId,action=list 也只返回摘要,不会返回完整资源明细或 expiry。账号级登录可传 region(ap-shanghai/ap-guangzhou/ap-singapore)查询对应地域,对齐 CLI `tcb env list -r <region>`;环境级凭证(API Key / 托管授权 token)只能看到绑定的 envId,返回 credential_scope=single_env,此时 region 不参与查询会在 ignored_params 中如实说明(AppliedFilters.region 为 null),不要误判为环境不存在或地域过滤失效。如需查询某个已知 EnvId 对应环境的详细信息(包括资源字段和计费信息),必须使用 action=info 并传入目标环境的 envId 参数。action=info 会在可用时补充 BillingInfo(如 ExpireTime、PayMode、IsAutoRenew 等计费字段)。 📊 action=usage 对齐 tcb env usage/info:透传 Manager SDK describeEnvAccountCircle + describeCreditsUsageDetail,返回计费周期与各模块资源点用量(FLEXDB/SCF/COS 等)。envId 必填;type 可选过滤模块;未传 startDate/endDate 时自动使用当前计费周期。 📈 action=metrics 对齐 TCB DescribeCurveData(manager.monitor.describeCurveData,不是云监控 GetMonitorData):查询环境/网关 QPS、云函数调用与错误、数据库 CPU/内存/磁盘、云托管 CPU/QPS 等时序。envId 与 metricName 必填;startTime/endTime 格式 YYYY-MM-DD HH:mm:ss,须成对传入,不传则默认最近 24 小时;period 仅 300/3600/86400。GatewayTraceEnvQPS 未传 resourceID 时自动填环境级 all|:|all|:|all|:|all;云托管 Tke* 指标必须传服务名 resourceID。禁止用 callCloudApi 猜测监控 Action。 🔍 action=info 还会派生三个用于后端选型的字段(PG 环境另附实例形态): - `EnvInfo.RuntimeMode`:'postgresql' 或 'nosql',表示新业务建议默认使用的后端(PG 已开通时为 postgresql,否则为 nosql)。 - `EnvInfo.RuntimeBackends`:`{postgresql, nosql, mysql}` 三个布尔值,描述当前环境实际并存的后端。 - `EnvInfo.RuntimeModeHints`:每个后端对应的 API/工具/skill 提示。 - `EnvInfo.PostgreSQL[].TenantType`:PG 实例形态 —— `SHARED`(仅支持 SDK / 网关访问)或 `DEDICATED`(有私网 host / TCP 直连)。 🌐 action=info 还会在不改写 `StaticStorages[].StaticDomain`(云 API 名义域名)的前提下,投影网关路由 Enable 状态:`StaticStorages[].staticDomainRouteEnabled` 与 `EnvInfo.staticDomainRouteEnabled`(与 queryHosting websiteConfig 同源)。`false` 表示默认静态域名根路由已禁用(访问会返回 GATEWAY_ROUTE_DISABLED),勿把名义域名当成可达 URL。 AI 在写业务/权限/存储代码前必须先看这三项:PG 模式下新业务推荐 `app.rdb()` + RLS(`managePgDatabase action=execute` 跑 `CREATE POLICY`)+ pgstore;已存在的 NoSQL 集合 / 旧 storage / `managePermissions(resourceType="noSqlDatabase")` 在普通 PG 环境下仍然有效。**例外(pgdoc)**:当文档型数据库请求由 PostgreSQL 承载、客户端 SDK 调用保持不变时,集合的 CUSTOM 安全规则不生效,只能用四种基础权限或把校验放到云函数;此时不要把已有文档型代码改写成 `app.rdb()`,也不要假设数据会自动搬迁。`RuntimeBackends` 只列环境里有哪些数据库资源,不表示文档型请求由谁承载,启用状态以使用者说明为准。真正不适用的是 MySQL 与数据模型:当 `RuntimeBackends.mysql === false` 时,`manageMysqlDatabase` / `queryMysqlDatabase` / `relational-database-mcp-cloudbase` skill 都不该使用;`manageDataModel` / `modifyDataModel` 只在传统模式下可用,PG 环境没有对应功能。
envDomainManagementアクション⚠️ DEPRECATED:此工具已废弃并收编进 manageEnv,请改用 manageEnv(action="addSecurityDomain") / manageEnv(action="removeSecurityDomain")(入参 domains 完全一致)。本别名将在下个版本移除。 管理【环境安全域名】=浏览器跨域(CORS)白名单:控制允许哪些网页 origin(host:port)从浏览器直接调用本环境的 CloudBase 资源。只做 CORS 来源验证,不提供访问域名,不涉及 HTTPS 证书。⚠️ 与【网关自定义域名】是两套完全独立的配置,互不相干:如需给自己的域名绑定 HTTPS 访问入口(云托管 / 网关服务),那属于 manageGateway 的职责——先 queryGateway(listCustomDomains);已有域名则 manageGateway(createRoute) 显式传 domain(无需证书);仅首次绑定新域名才用 bindCustomDomain(需 certificateId)。不要用本工具做这件事。 操作指引:(原工具名 createEnvDomain/deleteEnvDomain,为兼容旧 AI 规则可继续使用这些名称)当浏览器 Web 应用需要从本地 Vite / dev server 直接访问 CloudBase 资源时,先用 queryEnv(action=domains) 检查当前实际浏览器 origin 对应的 host:port 是否已在白名单中,再按该实际值添加。新增或删除后请每约 10 秒轮询 queryEnv(action=domains) 确认状态收敛,勿一次 sleep 满 10 分钟;多数环境数分钟内可收敛。
manageEnvアクション管理 CloudBase 环境,支持:listPackages=查询可选套餐列表,create=创建新环境(需确认),modifyPlan=变更套餐(升降配,需确认),renew=续费环境(需确认),addSecurityDomain=添加环境安全域名(浏览器 CORS 白名单,不计费、无需确认),removeSecurityDomain=删除环境安全域名(不计费、无需确认)。 ⚠️ 涉及费用的操作(create/modifyPlan/renew),执行前必须展示配置摘要并等待用户通过 confirm="yes" 确认;安全域名操作(addSecurityDomain/removeSecurityDomain)不计费,无需 confirm。 ℹ️ 安全域名=浏览器跨域(CORS)白名单,控制允许哪些网页 origin(host:port)从浏览器直接调用本环境的 CloudBase 资源,不提供访问域名、不涉及 HTTPS 证书。给自己的域名绑定 HTTPS 访问入口(云托管/网关服务)属于 manageGateway(listCustomDomains/bindCustomDomain)的职责,与本工具无关。
readNoSqlDatabaseStructure読み取り専用读取 CloudBase NoSQL 数据库集合与索引结构,支持列出集合、查看集合详情、列出索引以及检查索引是否存在。本工具为服务端管理工具,用于管理端查询数据库结构,不用于编写客户端代码。
writeNoSqlDatabaseStructureアクション创建、删除和管理 CloudBase NoSQL 数据库集合(collection)。支持创建新集合、删除现有集合,以及通过 updateCollection 的 updateOptions.CreateIndexes / updateOptions.DropIndexes 添加索引和删除索引。当需要新建集合时,使用 action=createCollection。本工具为服务端管理工具,用于管理端操作集合和索引结构,不用于编写客户端代码。
readNoSqlDatabaseContent読み取り専用查询 CloudBase NoSQL 数据库中的数据记录。支持按条件筛选、分页、排序,适用于管理端数据查询与运维。limit 默认 100、最大 1000;超出请用 offset 分页。projection 仅支持 { field: 1|0 } 对象(示例 {"_id":1,"name":1,"createdAt":1}),不要传字段数组。
writeNoSqlDatabaseContentアクション修改 CloudBase NoSQL 数据库中的数据记录。支持插入、更新(含 $set/$inc/$push 等操作符)、删除、upsert 等操作,适用于管理端数据写入与运维。⚠️ 服务端写入不含 _openid:若集合依赖客户端 SDK(@cloudbase/js-sdk 或微信小程序 wx.cloud.database())的行级安全规则(如 doc._openid == auth.openid),服务端写入时需手动补充 _openid 字段,否则客户端将无法读取到该数据。⚠️ 部分更新嵌套字段须使用点号路径,如 `$set: {"shipping.city": "guangzhou"}`,直接传嵌套对象会覆盖整个字段。
manageDataModel読み取り専用数据模型查询工具,支持查询和列表数据模型(只读操作)。通过 action 参数区分操作类型:list=获取模型列表(不含Schema,可选 names 参数过滤),get=查询单个模型详情(含Schema字段列表、格式、关联关系等,需要提供 name 参数),docs=生成SDK使用文档(需要提供 name 参数)
modifyDataModelアクション基于Mermaid classDiagram创建数据模型。为保持兼容性,工具名仍为 modifyDataModel;当前仅支持创建新模型,不支持更新现有模型结构。内置异步任务监控,自动轮询直至完成或超时。
queryPgDatabase読み取り専用⚠️ 只读工具:只接受 SELECT 等只读 SQL。CREATE / ALTER / DROP / INSERT / UPDATE / DELETE 会被直接拒绝(STATE 42703/42P01 也多半是表名或列名猜错,先 action=objects 看真实结构,不要凭惯例猜 schema_migrations 之类的表)。写入与 DDL 请改用 managePgDatabase:DML/GRANT/RLS 用 action=execute,建表/改 schema 用 action=applyMigration。 查询 CloudBase PostgreSQL 数据库:获取当前 PG 上下文、列出带 schema 的数据库对象、读取轻量元数据、检查单个对象结构,以及执行只读 SQL。
managePgDatabaseアクション管理 CloudBase PostgreSQL:执行已确认的写入 SQL、SQL 风险预检、迁移管理,以及 Realtime 配置管理。建表/ALTER/DROP 等 schema 变更必须使用 applyMigration(显式 migrationVersion;成功前自动写入或校验本地 cloudbase/migrations/<version>_<name>.sql,与 CLI tcb db pg migration 一致),不要默认用 execute。execute 主要用于 DML 与 GRANT/RLS 等运维 SQL。Realtime 三个 action:describeRealtime 读取配置(响应没有开通态字段,成功不代表已开通);enableRealtime 开通并解除挂起,等价把 Suspend 置为 false(未开通环境首次调用会自动完成开通,已开通且未挂起时无副作用);modifyRealtime 按显式传入项增量修改(需 confirm=true,改 suspend 会立即断开该环境全部在线 WebSocket 连接,全局生效)。客户端接入写法见 postgresql-development-cloudbase skill 的 references/realtime.md。
| auth | CloudBase(腾讯云开发)开发阶段登录与环境绑定。不确定该从哪开始?先调一次 auth(status)(只读、不用参数),确认登录态和当前环境。登录后即可访问云资源;环境(env)是云函数、数据库、静态托管等资源的隔离单元,绑定环境后其他 MCP 工具才能操作该环境。还没有环境时:国内站新用户可以免费开通一个体验环境,开通后再用 set_env 绑定。支持:查询状态、发起登录、API Key登录、绑定环境(set_env)、退出登录。auth(status) 会返回 credential_scope(account=账号级 / single_env=环境级 API Key)与当前 region;环境级 API Key 只能看到绑定的 envId,查不到其他地域环境是权限边界而非环境不存在。可选 site/region/lang 参数:site=站点(domestic/intl),region=地域,lang=输出语言(zh/en)。 | アクション |
| queryEnv | 查询 CloudBase 环境相关信息,支持查询环境列表、指定环境详情、安全域名、资源用量与监控指标。(曾用名:envQuery、listEnvs、getEnvInfo、getEnvAuthDomains)当 action=list 时,会按 DescribeEnvs 语义做列表/筛选,标准返回字段为 EnvId、Alias、Status、EnvType、Region、PackageId、PackageName、IsDefault,并支持通过 fields 白名单裁剪这些字段;aliasExact=true 时会按别名精确筛选,避免把前缀相近的环境误当作候选;即使传入 envId,action=list 也只返回摘要,不会返回完整资源明细或 expiry。账号级登录可传 region(ap-shanghai/ap-guangzhou/ap-singapore)查询对应地域,对齐 CLI `tcb env list -r <region>`;环境级凭证(API Key / 托管授权 token)只能看到绑定的 envId,返回 credential_scope=single_env,此时 region 不参与查询会在 ignored_params 中如实说明(AppliedFilters.region 为 null),不要误判为环境不存在或地域过滤失效。如需查询某个已知 EnvId 对应环境的详细信息(包括资源字段和计费信息),必须使用 action=info 并传入目标环境的 envId 参数。action=info 会在可用时补充 BillingInfo(如 ExpireTime、PayMode、IsAutoRenew 等计费字段)。 📊 action=usage 对齐 tcb env usage/info:透传 Manager SDK describeEnvAccountCircle + describeCreditsUsageDetail,返回计费周期与各模块资源点用量(FLEXDB/SCF/COS 等)。envId 必填;type 可选过滤模块;未传 startDate/endDate 时自动使用当前计费周期。 📈 action=metrics 对齐 TCB DescribeCurveData(manager.monitor.describeCurveData,不是云监控 GetMonitorData):查询环境/网关 QPS、云函数调用与错误、数据库 CPU/内存/磁盘、云托管 CPU/QPS 等时序。envId 与 metricName 必填;startTime/endTime 格式 YYYY-MM-DD HH:mm:ss,须成对传入,不传则默认最近 24 小时;period 仅 300/3600/86400。GatewayTraceEnvQPS 未传 resourceID 时自动填环境级 all|:|all|:|all|:|all;云托管 Tke* 指标必须传服务名 resourceID。禁止用 callCloudApi 猜测监控 Action。 🔍 action=info 还会派生三个用于后端选型的字段(PG 环境另附实例形态): - `EnvInfo.RuntimeMode`:'postgresql' 或 'nosql',表示新业务建议默认使用的后端(PG 已开通时为 postgresql,否则为 nosql)。 - `EnvInfo.RuntimeBackends`:`{postgresql, nosql, mysql}` 三个布尔值,描述当前环境实际并存的后端。 - `EnvInfo.RuntimeModeHints`:每个后端对应的 API/工具/skill 提示。 - `EnvInfo.PostgreSQL[].TenantType`:PG 实例形态 —— `SHARED`(仅支持 SDK / 网关访问)或 `DEDICATED`(有私网 host / TCP 直连)。 🌐 action=info 还会在不改写 `StaticStorages[].StaticDomain`(云 API 名义域名)的前提下,投影网关路由 Enable 状态:`StaticStorages[].staticDomainRouteEnabled` 与 `EnvInfo.staticDomainRouteEnabled`(与 queryHosting websiteConfig 同源)。`false` 表示默认静态域名根路由已禁用(访问会返回 GATEWAY_ROUTE_DISABLED),勿把名义域名当成可达 URL。 AI 在写业务/权限/存储代码前必须先看这三项:PG 模式下新业务推荐 `app.rdb()` + RLS(`managePgDatabase action=execute` 跑 `CREATE POLICY`)+ pgstore;已存在的 NoSQL 集合 / 旧 storage / `managePermissions(resourceType="noSqlDatabase")` 在普通 PG 环境下仍然有效。**例外(pgdoc)**:当文档型数据库请求由 PostgreSQL 承载、客户端 SDK 调用保持不变时,集合的 CUSTOM 安全规则不生效,只能用四种基础权限或把校验放到云函数;此时不要把已有文档型代码改写成 `app.rdb()`,也不要假设数据会自动搬迁。`RuntimeBackends` 只列环境里有哪些数据库资源,不表示文档型请求由谁承载,启用状态以使用者说明为准。真正不适用的是 MySQL 与数据模型:当 `RuntimeBackends.mysql === false` 时,`manageMysqlDatabase` / `queryMysqlDatabase` / `relational-database-mcp-cloudbase` skill 都不该使用;`manageDataModel` / `modifyDataModel` 只在传统模式下可用,PG 环境没有对应功能。 | 読み取り専用 |
| envDomainManagement | ⚠️ DEPRECATED:此工具已废弃并收编进 manageEnv,请改用 manageEnv(action="addSecurityDomain") / manageEnv(action="removeSecurityDomain")(入参 domains 完全一致)。本别名将在下个版本移除。 管理【环境安全域名】=浏览器跨域(CORS)白名单:控制允许哪些网页 origin(host:port)从浏览器直接调用本环境的 CloudBase 资源。只做 CORS 来源验证,不提供访问域名,不涉及 HTTPS 证书。⚠️ 与【网关自定义域名】是两套完全独立的配置,互不相干:如需给自己的域名绑定 HTTPS 访问入口(云托管 / 网关服务),那属于 manageGateway 的职责——先 queryGateway(listCustomDomains);已有域名则 manageGateway(createRoute) 显式传 domain(无需证书);仅首次绑定新域名才用 bindCustomDomain(需 certificateId)。不要用本工具做这件事。 操作指引:(原工具名 createEnvDomain/deleteEnvDomain,为兼容旧 AI 规则可继续使用这些名称)当浏览器 Web 应用需要从本地 Vite / dev server 直接访问 CloudBase 资源时,先用 queryEnv(action=domains) 检查当前实际浏览器 origin 对应的 host:port 是否已在白名单中,再按该实际值添加。新增或删除后请每约 10 秒轮询 queryEnv(action=domains) 确认状态收敛,勿一次 sleep 满 10 分钟;多数环境数分钟内可收敛。 | アクション |
| manageEnv | 管理 CloudBase 环境,支持:listPackages=查询可选套餐列表,create=创建新环境(需确认),modifyPlan=变更套餐(升降配,需确认),renew=续费环境(需确认),addSecurityDomain=添加环境安全域名(浏览器 CORS 白名单,不计费、无需确认),removeSecurityDomain=删除环境安全域名(不计费、无需确认)。 ⚠️ 涉及费用的操作(create/modifyPlan/renew),执行前必须展示配置摘要并等待用户通过 confirm="yes" 确认;安全域名操作(addSecurityDomain/removeSecurityDomain)不计费,无需 confirm。 ℹ️ 安全域名=浏览器跨域(CORS)白名单,控制允许哪些网页 origin(host:port)从浏览器直接调用本环境的 CloudBase 资源,不提供访问域名、不涉及 HTTPS 证书。给自己的域名绑定 HTTPS 访问入口(云托管/网关服务)属于 manageGateway(listCustomDomains/bindCustomDomain)的职责,与本工具无关。 | アクション |
| readNoSqlDatabaseStructure | 读取 CloudBase NoSQL 数据库集合与索引结构,支持列出集合、查看集合详情、列出索引以及检查索引是否存在。本工具为服务端管理工具,用于管理端查询数据库结构,不用于编写客户端代码。 | 読み取り専用 |
| writeNoSqlDatabaseStructure | 创建、删除和管理 CloudBase NoSQL 数据库集合(collection)。支持创建新集合、删除现有集合,以及通过 updateCollection 的 updateOptions.CreateIndexes / updateOptions.DropIndexes 添加索引和删除索引。当需要新建集合时,使用 action=createCollection。本工具为服务端管理工具,用于管理端操作集合和索引结构,不用于编写客户端代码。 | アクション |
| readNoSqlDatabaseContent | 查询 CloudBase NoSQL 数据库中的数据记录。支持按条件筛选、分页、排序,适用于管理端数据查询与运维。limit 默认 100、最大 1000;超出请用 offset 分页。projection 仅支持 { field: 1|0 } 对象(示例 {"_id":1,"name":1,"createdAt":1}),不要传字段数组。 | 読み取り専用 |
| writeNoSqlDatabaseContent | 修改 CloudBase NoSQL 数据库中的数据记录。支持插入、更新(含 $set/$inc/$push 等操作符)、删除、upsert 等操作,适用于管理端数据写入与运维。⚠️ 服务端写入不含 _openid:若集合依赖客户端 SDK(@cloudbase/js-sdk 或微信小程序 wx.cloud.database())的行级安全规则(如 doc._openid == auth.openid),服务端写入时需手动补充 _openid 字段,否则客户端将无法读取到该数据。⚠️ 部分更新嵌套字段须使用点号路径,如 `$set: {"shipping.city": "guangzhou"}`,直接传嵌套对象会覆盖整个字段。 | アクション |
| manageDataModel | 数据模型查询工具,支持查询和列表数据模型(只读操作)。通过 action 参数区分操作类型:list=获取模型列表(不含Schema,可选 names 参数过滤),get=查询单个模型详情(含Schema字段列表、格式、关联关系等,需要提供 name 参数),docs=生成SDK使用文档(需要提供 name 参数) | 読み取り専用 |
| modifyDataModel | 基于Mermaid classDiagram创建数据模型。为保持兼容性,工具名仍为 modifyDataModel;当前仅支持创建新模型,不支持更新现有模型结构。内置异步任务监控,自动轮询直至完成或超时。 | アクション |
| queryPgDatabase | ⚠️ 只读工具:只接受 SELECT 等只读 SQL。CREATE / ALTER / DROP / INSERT / UPDATE / DELETE 会被直接拒绝(STATE 42703/42P01 也多半是表名或列名猜错,先 action=objects 看真实结构,不要凭惯例猜 schema_migrations 之类的表)。写入与 DDL 请改用 managePgDatabase:DML/GRANT/RLS 用 action=execute,建表/改 schema 用 action=applyMigration。 查询 CloudBase PostgreSQL 数据库:获取当前 PG 上下文、列出带 schema 的数据库对象、读取轻量元数据、检查单个对象结构,以及执行只读 SQL。 | 読み取り専用 |
| managePgDatabase | 管理 CloudBase PostgreSQL:执行已确认的写入 SQL、SQL 风险预检、迁移管理,以及 Realtime 配置管理。建表/ALTER/DROP 等 schema 变更必须使用 applyMigration(显式 migrationVersion;成功前自动写入或校验本地 cloudbase/migrations/<version>_<name>.sql,与 CLI tcb db pg migration 一致),不要默认用 execute。execute 主要用于 DML 与 GRANT/RLS 等运维 SQL。Realtime 三个 action:describeRealtime 读取配置(响应没有开通态字段,成功不代表已开通);enableRealtime 开通并解除挂起,等价把 Suspend 置为 false(未开通环境首次调用会自动完成开通,已开通且未挂起时无副作用);modifyRealtime 按显式传入项增量修改(需 confirm=true,改 suspend 会立即断开该环境全部在线 WebSocket 连接,全局生效)。客户端接入写法见 postgresql-development-cloudbase skill 的 references/realtime.md。 | アクション |
42個のツールをすべて表示ツールを折りたたむ
queryPgStorage読み取り専用查询 CloudBase PostgreSQL 环境下的云存储能力。返回 bucket/config 能力摘要、对象信息查询方案,以及基于 HTTP API 或 SDK 的上传实现方案;不会读取本地文件,也不会默认输出大量签名 URL。
queryMysqlDatabase読み取り専用查询 CloudBase MySQL 数据库信息。支持执行只读 SQL、查询实例创建任务结果(控制台发起)、查询 MySQL 任务状态、获取当前实例生命周期上下文,以及查询实例慢查询/错误日志(对齐 Manager SDK describeInstanceSlowQueries / describeInstanceErrorLogs)。标准 getInstanceInfo/describeInstance 不返回连接凭据;仅 getConnectionInfo 透传原始连接/集群载荷(含可能的凭据),且仅用于显式 TCP 迁移。业务 CRUD 优先使用 SDK 或 runQuery/runStatement。
manageMysqlDatabaseアクション管理既有 CloudBase MySQL 实例:支持销毁实例、执行写入 SQL/DDL、初始化数据库 Schema。注意:MySQL 开通能力已下线,本工具不再创建实例——需要新开通请前往云开发控制台。环境内没有实例时返回 MYSQL_NOT_CREATED 并给出控制台入口,不再提供开通引导。新环境请优先使用 CloudBase PostgreSQL(managePgDatabase / queryPgDatabase)。
queryFunctions読み取り専用CloudBase 云函数统一只读入口。通过更自解释的 action 查询 CloudBase 云函数列表、函数详情、执行日志、层、触发器、代码下载地址、已发布版本与流量别名。 **分页说明**:`listFunctions`、`listLayers`、`listVersionByFunction` 支持 `limit` 和 `offset` 参数。 - `limit`: 分页数量,默认值由后端决定 - `offset`: 分页偏移,从 0 开始 - 示例:`queryFunctions(action="listFunctions", offset=10, limit=10)` **查询 CloudBase 云函数日志**:`action="listFunctionLogs"`,需要提供 `functionName`。日志从 CLS 检索(底层 GetFunctionLogs 接口已下线)。 - 示例:`queryFunctions(action="listFunctionLogs", functionName="my-function")` - 不传 startTime/endTime 时默认查最近 1 天;跨度不能超过 1 天,单次最多返回 100 条 - 返回 `hasMore=true` 表示还有更早的日志:把返回的 `context` 原样传回取下一页(`offset` 只在前 100 条内生效) - `logs[]` 已解析成 requestId / log / statusCode / retCode / durationMs / memoryMb / timestamp - 想看某一次调用的完整过程(START、业务日志、REPORT):`queryFunctions(action="getFunctionLogDetail", requestId="xxx")` **定时任务 / cron / 定时跑**:使用 `listFunctionTriggers` 查询函数的 timer 触发器配置。 **版本与流量路由**:`listVersionByFunction` 列出已发布版本(对齐 tcb fn list-function-versions);`getFunctionAlias` 查看别名/灰度配置(对齐 tcb fn get-route,aliasName 默认 `$DEFAULT`)。 **层(Layer)说明**: - 层为 SCF 账号级共享命名空间:不同环境创建同名层会共享同一层的版本序列;删除某版本会影响所有绑定该版本的环境的函数 - 创建层必须用带环境标识的唯一层名,固定格式:`{layerName}_{当前envId}`(如 `common_cloud1-d9ghadgak3edf6b36`)。不要在不同环境使用相同裸层名,创建前先 `listLayers` 查重 - `listLayers` / `listLayerVersions` / `getLayerVersionDetail` 返回账号级视图,可能含其他环境创建的层 **区分 `queryLogs` 工具**: - 本工具用于查询特定 CloudBase 云函数的执行日志 - `queryLogs` 工具用于搜索 CLS 日志服务(跨服务日志聚合)
manageFunctionsアクションCloudBase 云函数统一写入口。支持创建函数、更新代码、更新配置、调用函数、发布版本、配置流量别名、管理定时跑 / 定时任务 / scheduled job 的 timer 触发器和层绑定。部署包体积有硬上限:请勿把静态内容打进包里——媒体文件(视频、大图、字体)、用户上传的文件、以及频繁更新的静态资源都应放云存储按 URL 引用,否则每次改动都要重新部署函数,包还可能超限。如果要创建 cron 定时任务,先用 createFunction 创建函数,再用 createFunctionTrigger 创建 timer 触发器(支持7段cron表达式),deleteFunctionTrigger 删除触发器。版本发布:`publishVersion` 对齐 tcb fn publish-version / SDK publishVersion;灰度/切流:`updateFunctionAliasConfig` 对齐 tcb fn config-route / SDK updateFunctionAliasConfig(aliasName 默认 `$DEFAULT`)。HTTP 云函数镜像构建部署:createFunction / updateFunctionCode 通过 func.buildStrategy 区分。func.buildStrategy=image(已有镜像,填 func.imageConfig.imageUri)直接创建/更新 HTTP 函数;func.buildStrategy=local(本地 Docker 构建推送)、cloud(CloudApp 云端构建)走镜像构建部署编排(需要 func.imageConfig;build 非必填,缺省仓库坐标自动补齐:namespace 默认 envId、repository 默认函数名),默认仅生成 dry-run 计划;传入 dryRun=false 且 confirm=true 后执行真实部署。真实部署可传 wait=false 立即返回 taskId,再通过 queryFunctions 的 getFunctionDeployStatus 查询进度和结果。wait=false 仅表示当前 Tool 不等待完整部署;调用方不得在 status=running 时结束流程,必须自动轮询到 succeeded/failed 后再向用户汇报,除非达到轮询上限。local 始终要求本地 MCP 模式;cloud 的真实执行需要读取本地构建上下文,也要求本地 MCP 模式;cloud mode 仅支持 cloud dry-run 和 image 策略。func.buildStrategy 省略或为 zip 时按传统代码包部署。危险操作需要显式 confirm=true。 **个人版 TCR 凭证**:imageType=personal 的 local/cloud 构建需要推送凭证。若 MCP 配置的 env 中已设置 TCB_TCR_USERNAME 与 TCB_TCR_PASSWORD(与 TENCENTCLOUD_SECRETID 等密钥同样的配置方式),则不需要在请求参数中传递 func.imageConfig.build.registryCredential,留空即可自动读取。不要向用户索要密码明文,也不要把密码写进工具参数。 注意这条 env 通道只在**本地 stdio MCP、且客户端的 mcp.json 支持自定义 env 块**时可用:部分 GUI 客户端不继承 shell 的 export,IDE 内置型 MCP 的凭据注入通常是硬编码白名单(例如只放行 TENCENTCLOUD_*),这类用户没有配置自定义 env 的通道,「在 MCP 配置的 env 中设置」对他们是无效指引。面向内置 MCP 用户应改为引导:使用企业版(imageType=enterprise,走实例临时令牌,不需要固定密码),或改用 buildStrategy=image 直接部署已推送的镜像。 **企业版登录态要求**:enterprise 的 cloud/local 构建要经 CAM 铸造 TCR 临时令牌,环境级 API Key 与 OAuth 换出的临时凭据都不带 CAM 策略,会被前置拦截并提示改用账号级密钥或 image 策略;个人版走静态密码直接 docker login,不经过 CAM,反而是 API Key 用户唯一能走通的构建路径。 **层(Layer)说明**: - 层为 SCF 账号级共享命名空间:不同环境创建同名层会共享同一层的版本序列;删除某版本会影响所有绑定该版本的环境的函数 - 创建层必须用带环境标识的唯一层名,固定格式:`{layerName}_{当前envId}`(如 `common_cloud1-d9ghadgak3edf6b36`)。不要在不同环境使用相同裸层名,创建前先 `listLayers` 查重 - 相关 action:`createLayerVersion` / `deleteLayerVersion` / `attachLayer` / `detachLayer` / `updateFunctionLayers`(只读查询见 queryFunctions 的 listLayers / listLayerVersions / getLayerVersionDetail)
queryHosting読み取り専用查询 CloudBase 静态托管的只读信息。适合 AI 先做发现再决定下一步:action=websiteConfig 查询首页/错误页/路由规则与站点域名信息;action=status 查询托管服务状态;action=findFiles 按前缀查找文件;action=listFiles 列出全部托管文件;action=domainStatus 查询自定义域名的当前状态与配置。该工具不会产生任何副作用。
manageHostingアクション管理 CloudBase 静态托管的变更操作。action=upload 上传本地构建产物到共享域名(域名格式:<envId>-<appId>.tcloudbaseapp.com/<cloudPath>);action=delete 删除托管文件或目录(必须 confirm=true);action=setWebsiteDocument 设置首页/错误页/路由规则;action=enableService 开通静态托管;action=bindDomain / unbindDomain / updateDomain 管理自定义域名;action=downloadFile / downloadDirectory 下载托管内容到本地。⚠️ 底层每次托管操作都会请求 DescribeStaticStore 管控接口(20 次/秒 QPS 限制):批量删除多个文件请逐次调用并保持间隔(建议每秒不超过 10 次),同一目录下多个文件可优先用 isDir=true 一次删除整个目录;若报错含 "frequency limit" 说明触发了限流,请等待 1-2 秒后重试,不要连续快速重试。⚠️ 本工具没有关闭默认域名(*.tcloudbaseapp.com)的 action;要禁用该默认公网域名,请用 manageGateway(action="disableRoute", domain=该 STATIC_STORE IsDefault 域名, path="/")(底层 ModifyHTTPServiceRoute,不是 ModifyGatewayRoute)。⚠️ 新项目部署优先使用 manageApps(部署到独立子域名),本工具适合已有老项目继续使用或作为 manageApps 的 fallback。manageApps 与 manageHosting 域名不同,切换会导致老链接失效。若任务只是查看配置、文件或域名状态,请改用 queryHosting。
queryStorage読み取り専用⚠️ PG 模式环境请使用 queryPgStorage 而非本工具(pgstore 与旧 COS 是两套独立系统)。 查询 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/`。
manageStorageアクション⚠️ PG 模式环境请使用 queryPgStorage 而非本工具(pgstore 与旧 COS 是两套独立系统)。 管理 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_FOUND` 或 `PUT https://undefined/`(DevTools 表现为 `net::ERR_NAME_NOT_RESOLVED`),先用本工具或控制台确认 / 创建对应的 pgstore bucket,再让前端重试上传,不要让前端把上传失败静默吞掉。`DescribeEnvs.Storages[]` 返回的旧 NoSQL bucket(形如 `<hash>-<envId>-<appId>`)不是可用的 pgstore bucket,切勿当作默认目标使用。
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、CodeBuddy、Claude Code 等主流编辑器),适合在已有项目中补充AI编辑器配置 支持的IDE类型: - all: 下载所有IDE配置 - cursor: Cursor AI编辑器 - codebuddy: CodeBuddy AI编辑器 - claude-code: Claude Code AI编辑器 - gemini-cli: Gemini CLI - opencode: OpenCode AI编辑器 - qwen-code: 通义灵码 - baidu-comate: 百度Comate - openai-codex-cli: OpenAI Codex CLI - github-copilot: GitHub Copilot - roocode: RooCode AI编辑器(仅 MCP 配置,不含规则文件) - tongyi-lingma: 通义灵码 - trae: Trae AI编辑器 - qoder: Qoder AI编辑器 - antigravity: Google Antigravity AI编辑器 - vscode: Visual Studio Code - kiro: Kiro AI编辑器(仅 MCP 配置,不含规则文件) - aider: Aider AI编辑器 - iflow-cli: iFlow CLI(仅 MCP 配置,不含规则文件) 注意:如果未传入 ide 参数且无法从环境变量检测到 IDE,将提示错误并要求传入 ide 参数 特别说明: - rules 模板会自动包含当前 MCP 版本号信息,便于后续维护和版本追踪 - 下载 rules 模板时,如果项目中已存在 README.md 文件,系统会自动保护该文件不被覆盖(除非设置 overwrite=true)
searchKnowledgeBase読み取り専用云开发知识库检索工具,支持 CloudBase 官方文档 (docs)、固定技能文档 (skill) 和 OpenAPI 文档 (openapi) 查询。 按场景选择 mode: - 工具调用报错且错误信息含具体错误码(如 OperationDenied.FreePackageDenied)时:mode=docs + action=searchDocs(query=错误码),先查错误码官方含义与处理指引再行动,不要凭猜测重试 - 不确定答案在哪、需要对官方文档做全文检索时:mode=docs + action=searchDocs(传 query 关键词) - 已知文档标题、层级路径或 URL 时:mode=docs + action=findByName(传 input)或 action=readDoc(传 docPath) - 需要某个场景的落地指南 / 最佳实践时:mode=skill + skillName - 需要 HTTP API 的接口定义时:mode=openapi + apiName ⚠️ 重要:当 CloudBase skills 处于禁用状态或当前 IDE 不支持 skill 文件读取时,必须使用 searchKnowledgeBase(mode=skill, skillName=...) 来获取 CloudBase 技能文档内容,而不是尝试直接读取 skill 文件。直接读取可能返回 400 错误。示例: - 需要最小 Web+数据库 Demo 路径时:searchKnowledgeBase(mode=skill, skillName=minimal-web-baas-demo) - 需要 auth-tool-cloudbase 指南时:searchKnowledgeBase(mode=skill, skillName=auth-tool-cloudbase) - 需要 auth-web-cloudbase 指南时:searchKnowledgeBase(mode=skill, skillName=auth-web-cloudbase) - 需要 cloudbase-agent 指南时:searchKnowledgeBase(mode=skill, skillName=cloudbase-agent) - 需要 MCP 接入方式(本地 / 远程)、用 mcporter 在命令行调用工具、或站点 / 插件开关时:searchKnowledgeBase(mode=skill, skillName=cloudbase-mcp) 返回内容包含该 skill 的 SKILL.md 全文,以及它在远端聚合仓(CNB raw)中的全部 .md 文件地址清单(SKILL.md 与 references/ 等,可直接 HTTP 抓取)。正文中代码栅栏之外的相对链接也会改写为绝对地址;若该 skill 在远端仓中不存在,则只返回内联内容并明确标注,不返回失效链接。 不确定该选哪个时:mode=skill 下不传 skillName、mode=openapi 下不传 apiName 直接调用,会返回当前可用清单及各自的适用场景 / 接口简介,再带上名称重新调用即可。可选名称也见本工具的 skillName / apiName 枚举(skill 共 0 个,API 共 0 个)。 注意:OpenAPI 文档 (openapi) 查询只需要传 mode="openapi" 和 apiName,不要传 action;action 仅用于 mode="docs"。
queryCloudRun読み取り専用查询云托管服务信息,支持获取服务列表、查询服务详情、获取可用模板列表、获取构建日志(getDeployLog,仅云端源码构建/依赖 CODING)、获取运行日志(getProcessLog,镜像与源码部署均可/不依赖 CODING)、获取部署记录以及查询环境云托管开通状态(envStatus)。返回的服务信息包括服务名称、状态、访问类型、配置详情以及最近部署上下文。
manageCloudRunアクション管理云托管服务,按开发顺序支持:开通云托管环境(initEnv)、初始化项目(可从模板开始,模板列表可通过 queryCloudRun 查询)、下载服务代码、本地运行(仅函数型服务)、部署代码、仅更新配置(updateConfig,无需重新上传代码)、删除服务。deploy 支持两种方式:1) 源码构建(传入 targetPath,本地代码打包上传,默认路径);2) 已有镜像部署(传入 imageUrl,如 ccr.ccs.tencentyun.com/ns/img:v1,走 DeployType=image 容器型部署,targetPath 可省略)。deploy 语义为「触发部署 + 轻量等待任务注册」(最多约 45s;不需要 buildId 时可传 waitRegistration=false 跳过等待)。源码构建返回 buildId,用 getDeployLog 轮询构建进度后再 getProcessLog;镜像部署(imageUrl)BuildId 常为 0,跳过 getDeployLog,返回 runId/next_step 引导 getProcessLog(或先 getDeployRecords 取 RunId)。若用户明确指定镜像或无需重新构建,必须传 imageUrl,不要仅因本地有源码目录就回退到源码构建。deploy 对已存在服务会先读取远程配置再合并(保留 VpcConf/EnvParams/OpenAccessTypes)。updateConfig 对齐控制台服务设置页。删除操作需要确认,建议设置force=true。新环境首次部署前若提示未开通云托管,先调用 initEnv 开通(异步、幂等)。部署前请确认镜像里没有静态内容:媒体文件(视频、大图、字体)、用户上传的文件、以及频繁更新的静态资源,都应放进云存储按 URL 引用,不要打进镜像——否则每次部署都要全量重推、每个扩容实例都要重拉,一个 demo 视频就能把 30 秒的部署拖成几分钟。
deployBuildアクション解析 cloudbaserc 并对 hosting[] 中配置了 buildCommand 的项目执行本地构建(仅执行 buildCommand,不安装依赖、不上传)。只处理 hosting[],不处理 cloudbaserc 的 app 资源 —— app 的产物需要你自己在项目目录构建(产物目录与构建命令可从 deployPlan 的 buildHint 读取),或改用 CLI `tcb app deploy` 走云端构建。声明式 hosting 部署拆分为「build → plan → apply」三步,本工具是第一步:先本地构建产物,再 deployPlan 预演,最后 deployApply 上传产物。deployApply 对 app 与 hosting 都不构建 —— 产物缺失时报 BUILD_OUTPUT_NOT_FOUND,hosting 可用本工具补齐,app 需你自行构建。纯静态托管(未配置 buildCommand 且无法探测框架)自动跳过。构建为纯本地操作:不解析环境、不要求登录,也不需要 confirm。 - cwd:项目根目录,默认当前工作目录 - mode:环境名,命中 envOverrides.<mode> 时合并对应的多环境覆盖配置
deployPlan読み取り専用解析 cloudbaserc 并计算声明式部署计划(dry-run,不产生任何变更)。这是 deployApply 的预演对仗工具:plan 计算、deployApply 执行同一份 cloudbaserc。返回每个资源的动作分类:create=新建,update=覆盖更新,skip=无变更/不会执行,conflict=检测到冲突需中断,deploy=直传覆盖。计划已按 yes 复算为「实际会发生的动作」:不传 yes=true 时,云端已存在的函数会标为 skip(并在 declaredStatus 保留 update),与 deployApply 的实际执行结果一致,避免预演与执行相反。 ⚠️ app / hosting 的计划项一律是「直传已有产物」:声明式部署只部署不构建,cloudbaserc 的 buildCommand / framework 只用于推断产物目录,不会被执行。 app / hosting 的计划项带 buildHint = { buildCommand, outputDir, artifactReady }(机器可读,不要去解析 details 里的中文文案):artifactReady=false 表示产物目录缺失或为空,此时 deployApply 必定失败(BUILD_OUTPUT_NOT_FOUND)。正确做法是先构建再 apply —— hosting 可调用 deployBuild;app 需在项目目录执行 buildHint.buildCommand(为 null 则本就无需构建)。构建完成后重新 deployPlan 确认 artifactReady=true,不要改配置绕过。 适用边界:本工具用于项目级声明式编排(一份 cloudbaserc 统一 plan/apply);单资源临时直传请用 manageFunctions/manageHosting/manageApps。 - cwd:项目根目录,默认当前工作目录 - mode:环境名,命中 envOverrides.<mode> 时合并对应的多环境覆盖配置 - envId:目标环境 ID,优先级高于 cloudbaserc 中的 envId;不传则用配置值或当前绑定环境 - only:仅计算指定资源类型的计划 - skip:跳过指定资源类型 - yes:与 deployApply 的 yes 对齐,用于复算已存在函数的有效动作。true=预演为覆盖更新(update);false(默认)=预演为保守跳过(skip)
deployApplyアクション解析 cloudbaserc 并按 database→functions→app→hosting→gateway 顺序执行声明式部署。这是 deployPlan 的执行对仗工具(plan 预演 / deployApply 执行同一份 cloudbaserc),属于本地形态的 apply(读本地 cloudbaserc 并把本地产物上传到云端),是会变更云端资源的写操作,必须显式传 confirm=true 才会执行。建议先用 deployPlan 预演,确认计划无误后再执行。 ⚠️ 只部署不构建:本工具不会执行任何构建命令(app 与 hosting 都不会)。cloudbaserc 里的 buildCommand / installCommand / framework 只用于推断产物目录,不会被执行。产物目录不存在或为空时报 BUILD_OUTPUT_NOT_FOUND —— hosting 先调 deployBuild,app 需让用户在项目目录执行其构建命令,完成后重试,不要改配置绕过。构建前可用 deployPlan 读取 buildHint.buildCommand / outputDir / artifactReady 确认该跑什么。app 需要云端构建时用 CLI `tcb app deploy`(本工具不提供云端构建)。 适用边界:本工具用于项目级声明式编排(一份 cloudbaserc 统一 plan/apply);单资源临时直传请用 manageFunctions/manageHosting/manageApps。 - confirm:必须显式传 true 才执行部署,否则直接拒绝 - confirmDestructive:当本次待执行的数据库迁移含破坏性语句(DROP/TRUNCATE/DELETE、ALTER…DROP/RENAME)时,除 confirm 外还必须显式传 confirmDestructive=true 才会执行;否则拒绝并列出命中的迁移与语句。无破坏性迁移时该参数不生效 - cwd:项目根目录,默认当前工作目录 - mode:环境名,命中 envOverrides.<mode> 时合并对应的多环境覆盖配置 - envId:目标环境 ID,优先级高于 cloudbaserc 中的 envId;不传则用配置值或当前绑定环境 - only:仅部署指定资源类型 - skip:跳过指定资源类型 - yes:遇到已存在资源时的处理方式。true=直接覆盖更新;false(默认)=保守跳过,在无法交互确认的场景下已存在资源不会被覆盖(与 deployPlan 的 yes 语义一致) - concurrency:同类型资源最大并行数,默认 1(串行) - continueOnError:某个资源失败后继续部署其余资源(database 失败仍强制中断)
queryGateway読み取り専用CloudBase HTTP 网关统一只读入口(Domain/Route)。查询域名下路径路由及其上游:WEB_SCF/SCF=云函数,CBR=云托管,STATIC_STORE=静态托管,STORAGE=云存储,LH=轻量应用服务器。主键为 Domain + Path;listRoutes / getRoute / listCustomDomains / getPrivilege / cachePurgeTask。getPrivilege 查询 HTTP 网关总开关(enableService)与访问鉴权(enableAuth)状态。cachePurgeTask 查询域名缓存清除任务(先 manageGateway purgeCache 拿 TaskId)。实现自定义域名访问前,先 listCustomDomains:若已有自定义域名,优先 createRoute 挂路由(无需证书 ID);仅在没有可用自定义域名时才 bindCustomDomain。
manageGatewayアクションCloudBase HTTP 网关统一写入口(Domain/Route)。createRoute/updateRoute/deleteRoute 把域名下的 path 转到上游;enableRoute/disableRoute 启用或禁用已有路由(底层 ModifyHTTPServiceRoute 的 Routes[].Enable,不是 ModifyGatewayRoute)。未传 domain 时用 DomainType=HTTPSERVICE 的 IsDefault 默认 HTTP 域名(形如 *.{region}.app.tcloudbase.com),不会使用静态托管 CDN 域名(*.tcloudbaseapp.com,DomainType=STATIC_STORE)。这是网关默认域上的路径路由,不是 STATIC_STORE 上游绑定;STATIC_STORE 上游必须显式传 upstreamResourceType=STATIC_STORE。关闭静态托管默认域名(*.tcloudbaseapp.com):先 queryGateway(listRoutes) 找到 DomainType=STATIC_STORE 且 IsDefault=true 的 domain,再 manageGateway(action="disableRoute", domain=该域名, path="/");勿用 manageHosting。创建后可用 queryGateway(action="listRoutes") 核对 Domain / DomainType / Path / UpstreamResourceType。上游类型只用一个参数 upstreamResourceType(也可写在 route.upstreamResourceType,route 优先):WEB_SCF=HTTP云函数,SCF=Event云函数,CBR=云托管,STATIC_STORE=静态托管,STORAGE=云存储,LH=轻量应用服务器;配合 targetName 或 route.serviceName(云函数名/云托管服务名/静态托管实例名,常见 staticstore/云存储实例名)。createRoute 只建网关入口,不改上游权限。enablePathTransmission:默认 false 剥触发路径前缀;true 透传完整路径(CBR 多路由、WEB_SCF 自管子路径常需 true;STATIC_STORE 自定义触发路径映射站点根通常 false)。⚠️ 自定义域名访问:若环境已有自定义域名(先 queryGateway listCustomDomains),优先 createRoute 并显式传入该 domain,无需 certificateId;仅首次绑定全新自定义域名时用 bindCustomDomain(certificateId 可选:未传时按域名自动检索证书,单证书自动选用、多证书返回选择指引)。createRoute / bindCustomDomain 创建前会调用 VerifyHTTPServiceRoute 做归属权等预检(探测→创建);失败时返回 data.checks 与 DNS TXT 指引,配置后重试。CORS/安全域名(浏览器跨域白名单,与本工具的网关自定义域名无关)用 manageEnv(action=addSecurityDomain/removeSecurityDomain)。enableService/authSwitch:HTTP 网关总开关与访问鉴权开关;createRoute 后若访问报 HTTPSERVICE_NONACTIVATED,通常是总开关未开启(用 queryGateway getPrivilege 查询、enableService 开启)。purgeCache:清除域名缓存(CDN/EO,按 URL/前缀/整站),返回 TaskId 后用 queryGateway cachePurgeTask 查进度。路由级还支持 enableSafeDomain(跨域/合法域名校验)、pathRewrite(路径重写)、qpsPolicy(限频)、extension(自定义请求/响应头与缓存规则);域名级支持 protocol 与 domainExtension。updateRoute 只传要改的字段即可,未传的 CORS/重写/限频/扩展配置会保持原值。
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。
manageAppAuthアクションCloudBase 应用侧认证配置写入口。用于修改登录方式、provider、client 配置,确保 publishable key,以及创建或删除 API key、自定义登录密钥。⚠️ 本工具为管理端配置工具,不执行用户登录。当任务要求编写客户端登录代码时(例如「用 JS SDK 登录」),应先通过本工具完成配置(如启用 usernamePassword、获取 publishable key),再在项目代码中编写 @cloudbase/js-sdk 客户端登录代码(如 auth.signInWithPassword()),而非使用本工具完成登录。若前端要接受普通用户名样式标识符,应先执行 action=patchLoginStrategy 并传入 patch={ usernamePassword: true },再实现对应前端登录逻辑。⚠️ 短信验证码登录(patch={ phone: true })使用云开发默认短信通道,开启后即可收发验证码,不需要配置短信签名/模板/自定义 Provider;仅当需要自定义模板/签名或更换短信服务商时才需配置 SmsVerificationConfig 或自定义短信通道。⚠️ action=createApiKey 返回体中的 created 字段表示是否真正新建:created=false 说明复用了环境中已存在的 key,此时 keyName/expireIn 入参不会生效,返回的 keyName/expireAt 均为服务端真实值,并会附带 warnings,切勿把它当作临时凭证分发。
queryApps読み取り専用查询 CloudBase 应用部署的应用和版本。可查应用列表/详情、版本列表/详情;部署后用 getAppVersion 按 buildId 轮询构建状态;getBuildLog 可查询构建日志用于诊断失败原因。 action=getUploadUrl(只读)可获取预签名上传 URL:无本地文件系统时(cloud mode),先拿到 uploadUrl 自行 PUT 代码 zip,再用返回的 unixTimestamp 调 manageApps(action=deployApp, cosTimestamp) 触发部署。uploadUrl 是一次性上传凭据,不要外传或写进工单。
manageAppsアクション部署 Web 应用到 CloudBase(构建前后端,部署到独立子域名)。 云端上传通道(cloud mode,无本地文件系统):queryApps(action=getUploadUrl) 或 manageApps(action=getUploadUrl) 获取预签名上传 URL → agent 自行 PUT 代码 zip 到 uploadUrl(带 uploadHeaders 与 Content-Type: application/zip)→ 用返回的 unixTimestamp 作为 cosTimestamp 调 deployApp 触发部署。 action=getUploadUrl 获取预签名上传 URL(cloud mode 下使用),返回上传地址和 cosTimestamp。 action=deployApp 上传源码 ZIP 并触发远端构建部署管道: 1. 远端 npm install(可通过 installCmd="" 跳过) 2. 远端 npm run build(可通过 buildCmd="" 跳过) 3. 远端 tcb hosting deploy 域名格式:`<serviceName>-<envId>.webapps.tcloudbase.com`(每个 serviceName 一个独立子域名) ✅ 推荐用法(新项目/需要独立域名的 Web 应用,首选此工具): 新建项目首次部署时,传 framework=static, installCmd="", buildCmd="" 跳过远端构建, 只执行 tcb hosting deploy。部署后获得独立子域名,支持版本管理。 ⚠️ 兼容性说明: - 已有项目若之前用 manageHosting 部署过(域名格式:`<envId>-<appId>.tcloudbaseapp.com`), 切换到 manageApps 会产生全新的 URL,老链接失效。请保持原部署方式不变。 - 如需判断:调用 queryHosting 检查是否已有托管文件。 与 manageHosting 对比: - manageApps(本工具,新项目首选):域名 `<serviceName>-<envId>.webapps.tcloudbase.com`,独立子域名,支持版本管理 - manageHosting(已有项目或 fallback):域名 `<envId>-<appId>.tcloudbaseapp.com/<path>`,共享环境域名 两者均可绑定自定义域名。 ⚠️ 如果 manageApps 构建失败,先用 queryApps(action="getBuildLog") 查日志;仍不行再 fallback 到 manageHosting。
queryPermissions読み取り専用查询 CloudBase 权限与用户配置,支持查询资源权限(数据库/云函数/存储桶等)、角色列表/详情、应用用户列表/详情,以及网关 OPA 授权策略(对齐 CLI `tcb policy list/get`)。 示例: - 查询存储桶权限:`action="getResourcePermission", resourceType="storage", resourceId="bucket-name"` - 列出旧网关策略:`action="listPolicy"`(只有真实查询为空才等于「没有策略」;PG / OPA 引擎环境会跳过查询,返回 `skipped=true` 与空列表,**不代表没有策略**,请改用 getPolicy) - 读取用户 Rego:`action="getPolicy"`;平台扩展策略:`action="getPolicy", extension=true` 📌 跨后端边界提示:调用前先用 `queryEnv(action="info", envId=...)` 看 `EnvInfo.RuntimeBackends`。`resourceType="noSqlDatabase"` 查询的是 CloudBase NoSQL 集合规则,与 CloudBase PostgreSQL(PG)表的行级安全(RLS)是两套独立机制——同一个 PG 环境里 NoSQL 集合若仍在使用,对那些集合查询本工具结果**仍然有效**。要查 PG 表 RLS,请改用 `queryPgDatabase(action="sql", sql="SELECT * FROM pg_policies WHERE tablename=...")`。本工具不涉及 MySQL 权限。 ⚠️ PostgreSQL 环境:平台 `DescribeResourcePermission` 对 PG 环境会直接拒绝。当 `resourceType="function"` 时,本工具会自动回退到 Manager SDK `describeEnvAuthzConfig`(与 CLI `tcb policy get` 一致,读取 `authz.user.rego`)。显式 OPA 策略请用 `listPolicy` / `getPolicy`。 ⚠️ 角色类 action(`listRoles` / `getRole`)在 **PostgreSQL 类型环境**下平台侧一律拒绝(`The current API does not support PostgreSQL type environments.`)——这是平台能力边界,不是配置问题,**不要在 PG 环境反复重试**;PG 环境请改用 RLS(`managePgDatabase(action="execute")` 跑 `CREATE POLICY`)或控制台管理权限。
managePermissionsアクション管理 CloudBase 权限与用户配置,支持修改资源权限(数据库/云函数/存储桶等)、角色管理、成员与策略增删、应用用户 CRUD,以及设置网关 OPA Rego 策略(对齐 CLI `tcb policy set`)。 示例: - 设置存储桶为私有:`action="updateResourcePermission", resourceType="storage", resourceId="bucket-name", permission="PRIVATE"` - 创建角色:`action="createRole", roleName="admin", roleIdentity="admin"` - 放开云函数匿名/未登录访问(PG 会走 OPA,对齐 CLI `tcb policy set`):`action="updateResourcePermission", resourceType="function", resourceId="myFn", permission="CUSTOM", securityRule='{"invoke":true}'` - 直接设置用户 Rego:`action="setPolicy", regoContent="package authz.user\n\ndefault allow := false\n", confirm=true`(⚠️ 立即禁用旧网关鉴权) 注意:`createUser` / `updateUser` 是环境侧应用用户管理能力,适合测试账号、管理员或预置用户,不应替代浏览器里的 Web SDK 注册表单;前端用户名密码注册应使用 `auth.signUp({ username, password })`,登录应使用 `auth.signInWithPassword({ username, password })`。直接在浏览器里用 `auth.signUp` 创建用户名密码用户取决于 SDK/provider 支持,使用前必须验证;不支持时应走后端或管理端边界,不能在浏览器暴露密钥。`securityRule` 的详细语义取决于 `resourceType`:`doc._openid`、`auth.openid`、查询条件子集校验,以及 `create` / `update` / `delete` JSON 模板仅适用于 `resourceType="noSqlDatabase"` 的文档数据库安全规则;配置 `function` 或 `storage` 时,请参考各自官方安全规则文档,而不是复用 NoSQL 模板。 📌 跨后端边界提示:调用前先用 `queryEnv(action="info", envId=...)` 看 `EnvInfo.RuntimeBackends`: - `resourceType="noSqlDatabase"` 仅作用于 CloudBase NoSQL 文档数据库的集合;CloudBase PostgreSQL(PG)表的行级权限**不**受它控制——PG 表请改用 RLS:`managePgDatabase(action="execute", confirm=true)` 跑 `ALTER TABLE ... ENABLE ROW LEVEL SECURITY` 与 `CREATE POLICY ...`。同一个 PG 环境里如果还有 NoSQL 集合在用,对那些**集合**继续使用 `noSqlDatabase` 规则是正确的——不是"PG 环境就禁用本工具"。 - `resourceType="storage"` 控制的是 NoSQL/COS 存储桶 ACL;PG 的 `pgstore` bucket 不在此 `resourceType` 覆盖范围内。 - 本工具不涉及 MySQL;MySQL 数据库权限请走 MySQL 自身的 GRANT/REVOKE 语句(通过 `manageMysqlDatabase`)。 ⚠️ PostgreSQL 环境:平台 `ModifyResourcePermission` 对 PG 环境会直接拒绝。当 `resourceType="function"` 时,本工具会自动回退到 Manager SDK `modifyEnvAuthzConfig`(与 CLI `tcb policy set` 一致,写入 `authz.user.rego`)。`securityRule` 可传完整 Rego(`package authz.user`)或 `'{"invoke":true}'`(自动生成放通 anonymous/unauthenticated 调 functions 的策略)。设置 Rego 后会替换该环境整个用户策略文档(对全环境生效,不是单个函数/资源),旧网关鉴权立即失效且不会回退,与 CLI 行为一致。显式 OPA 策略请优先用 `action="setPolicy"`。 ⚠️ 角色类 action(`createRole` / `deleteRoles` / `updateRole`)在 **PostgreSQL 类型环境**下平台侧一律拒绝(`The current API does not support PostgreSQL type environments.`)——平台能力边界,不是配置问题,**不要在 PG 环境反复重试**;PG 环境请改用 RLS(`managePgDatabase(action="execute")` 跑 `CREATE POLICY`)或控制台管理权限。
queryLogs読み取り専用CloudBase 日志域统一只读入口。支持检查日志服务状态并搜索 CLS 日志。 **重要区分**: - 查询云函数日志:使用 `queryFunctions(action="listFunctionLogs", functionName="xxx")` - 查询 CLS 日志(跨服务日志聚合):使用本工具 `queryLogs(action="searchLogs")` - 开通 CLS 日志服务:使用 `manageLogs(action="createLogService", confirm=true)` **适用场景**: - 检查 CLS 日志服务是否开通:`action="checkLogService"` - 跨服务日志搜索(如搜索所有 ERROR 日志):`action="searchLogs"` - 按 CLS 语法检索特定服务的日志:`action="searchLogs", service="tcb|tcbr"`
manageLogsアクションCloudBase 日志域写入入口。用于开通 CLS 日志服务(对齐 Manager SDK `log.createLogService` / CreateEnvResource Resources=['log'])。 **适用场景**: - 开通 CLS 日志服务:`action="createLogService", confirm=true` 开通为异步操作:接口成功不代表立即可用,请随后用 `queryLogs(action="checkLogService")` 轮询确认。
queryAgents読み取り専用CloudBase Agent 域统一只读入口。支持列表、详情与日志查询。
manageAgentsアクションCloudBase Agent 域统一写入口。支持创建、更新和删除远端 Agent。
callCloudApiアクション通用的云 API 调用工具,主要用于 CloudBase / 腾讯云管控面与依赖资源相关 API 调用。**调用前必读接口索引** https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/api-reference.md (每日自动同步的 Action 级索引,含 rate limit;先查此索引确认 service/Action/参数,避免猜测 Action 名称;索引未覆盖的产品再去该产品官方 API 文档核对)。如果你的目标是通过 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 分类如下: **环境管理**: `CreateEnv`、`ModifyEnv`、`DescribeEnvs`、`DestroyEnv` **用户管理**: `CreateUser`、`ModifyUser`、`DescribeUserList`、`DeleteUsers` **认证配置**: `EditAuthConfig`、`DescribeAuthDomains` **云函数**: `DescribeFunctions`、`CreateFunction`、`UpdateFunctionCode`、`DeleteFunction` **数据库**: `CreateMySQLInstance`、`DescribeMySQLInstances`、`DestroyMySQLInstance` ⚠️ 云托管(CloudBase Run)统一走 tcbr service(CreateCloudRunEnv / CreateCloudRunServer / DescribeEnvBaseInfo / DescribeCloudRunEnvs,version="2022-02-17"),tcb 旧小租户接口 CreateCloudBaseRunResource 等已被禁用;部署请用 manageCloudRun。查询单个环境基础信息/是否已开通云托管用 DescribeEnvBaseInfo(EnvId 必填),查询环境列表及资源信息用 DescribeCloudRunEnvs(EnvId 可选过滤)。 ⚠️ Region 必须作为本工具顶层参数 `region` 传入(对应 X-TC-Region / 地域 endpoint),不要放进 params。params 里的 Region 会被剥离并当作顶层 region 使用。 销毁环境时,常见做法是至少带上 `EnvId` 和 `BypassCheck: true`,如果环境已经处于隔离期再按文档补 `IsForce: true`。
prepareFeedback読み取り専用返回公开仓库的新建 issue 页面。 **什么时候用**: - `channel="case"`:作品已经做出来,用户想展示到案例墙。 - `channel="retrospective"`:这次开发不顺利,用户想把卡点反馈给平台。 **怎么用**: - 只调用一次。返回的是页面地址,不是已提交的 issue。 - 在对话里写好正文,把链接交给用户。用户登录后自己提交。 - 不要代为提交,不要把环境 ID 或密钥写进正文。
| queryPgStorage | 查询 CloudBase PostgreSQL 环境下的云存储能力。返回 bucket/config 能力摘要、对象信息查询方案,以及基于 HTTP API 或 SDK 的上传实现方案;不会读取本地文件,也不会默认输出大量签名 URL。 | 読み取り専用 |
| queryMysqlDatabase | 查询 CloudBase MySQL 数据库信息。支持执行只读 SQL、查询实例创建任务结果(控制台发起)、查询 MySQL 任务状态、获取当前实例生命周期上下文,以及查询实例慢查询/错误日志(对齐 Manager SDK describeInstanceSlowQueries / describeInstanceErrorLogs)。标准 getInstanceInfo/describeInstance 不返回连接凭据;仅 getConnectionInfo 透传原始连接/集群载荷(含可能的凭据),且仅用于显式 TCP 迁移。业务 CRUD 优先使用 SDK 或 runQuery/runStatement。 | 読み取り専用 |
| manageMysqlDatabase | 管理既有 CloudBase MySQL 实例:支持销毁实例、执行写入 SQL/DDL、初始化数据库 Schema。注意:MySQL 开通能力已下线,本工具不再创建实例——需要新开通请前往云开发控制台。环境内没有实例时返回 MYSQL_NOT_CREATED 并给出控制台入口,不再提供开通引导。新环境请优先使用 CloudBase PostgreSQL(managePgDatabase / queryPgDatabase)。 | アクション |
| queryFunctions | CloudBase 云函数统一只读入口。通过更自解释的 action 查询 CloudBase 云函数列表、函数详情、执行日志、层、触发器、代码下载地址、已发布版本与流量别名。 **分页说明**:`listFunctions`、`listLayers`、`listVersionByFunction` 支持 `limit` 和 `offset` 参数。 - `limit`: 分页数量,默认值由后端决定 - `offset`: 分页偏移,从 0 开始 - 示例:`queryFunctions(action="listFunctions", offset=10, limit=10)` **查询 CloudBase 云函数日志**:`action="listFunctionLogs"`,需要提供 `functionName`。日志从 CLS 检索(底层 GetFunctionLogs 接口已下线)。 - 示例:`queryFunctions(action="listFunctionLogs", functionName="my-function")` - 不传 startTime/endTime 时默认查最近 1 天;跨度不能超过 1 天,单次最多返回 100 条 - 返回 `hasMore=true` 表示还有更早的日志:把返回的 `context` 原样传回取下一页(`offset` 只在前 100 条内生效) - `logs[]` 已解析成 requestId / log / statusCode / retCode / durationMs / memoryMb / timestamp - 想看某一次调用的完整过程(START、业务日志、REPORT):`queryFunctions(action="getFunctionLogDetail", requestId="xxx")` **定时任务 / cron / 定时跑**:使用 `listFunctionTriggers` 查询函数的 timer 触发器配置。 **版本与流量路由**:`listVersionByFunction` 列出已发布版本(对齐 tcb fn list-function-versions);`getFunctionAlias` 查看别名/灰度配置(对齐 tcb fn get-route,aliasName 默认 `$DEFAULT`)。 **层(Layer)说明**: - 层为 SCF 账号级共享命名空间:不同环境创建同名层会共享同一层的版本序列;删除某版本会影响所有绑定该版本的环境的函数 - 创建层必须用带环境标识的唯一层名,固定格式:`{layerName}_{当前envId}`(如 `common_cloud1-d9ghadgak3edf6b36`)。不要在不同环境使用相同裸层名,创建前先 `listLayers` 查重 - `listLayers` / `listLayerVersions` / `getLayerVersionDetail` 返回账号级视图,可能含其他环境创建的层 **区分 `queryLogs` 工具**: - 本工具用于查询特定 CloudBase 云函数的执行日志 - `queryLogs` 工具用于搜索 CLS 日志服务(跨服务日志聚合) | 読み取り専用 |
| manageFunctions | CloudBase 云函数统一写入口。支持创建函数、更新代码、更新配置、调用函数、发布版本、配置流量别名、管理定时跑 / 定时任务 / scheduled job 的 timer 触发器和层绑定。部署包体积有硬上限:请勿把静态内容打进包里——媒体文件(视频、大图、字体)、用户上传的文件、以及频繁更新的静态资源都应放云存储按 URL 引用,否则每次改动都要重新部署函数,包还可能超限。如果要创建 cron 定时任务,先用 createFunction 创建函数,再用 createFunctionTrigger 创建 timer 触发器(支持7段cron表达式),deleteFunctionTrigger 删除触发器。版本发布:`publishVersion` 对齐 tcb fn publish-version / SDK publishVersion;灰度/切流:`updateFunctionAliasConfig` 对齐 tcb fn config-route / SDK updateFunctionAliasConfig(aliasName 默认 `$DEFAULT`)。HTTP 云函数镜像构建部署:createFunction / updateFunctionCode 通过 func.buildStrategy 区分。func.buildStrategy=image(已有镜像,填 func.imageConfig.imageUri)直接创建/更新 HTTP 函数;func.buildStrategy=local(本地 Docker 构建推送)、cloud(CloudApp 云端构建)走镜像构建部署编排(需要 func.imageConfig;build 非必填,缺省仓库坐标自动补齐:namespace 默认 envId、repository 默认函数名),默认仅生成 dry-run 计划;传入 dryRun=false 且 confirm=true 后执行真实部署。真实部署可传 wait=false 立即返回 taskId,再通过 queryFunctions 的 getFunctionDeployStatus 查询进度和结果。wait=false 仅表示当前 Tool 不等待完整部署;调用方不得在 status=running 时结束流程,必须自动轮询到 succeeded/failed 后再向用户汇报,除非达到轮询上限。local 始终要求本地 MCP 模式;cloud 的真实执行需要读取本地构建上下文,也要求本地 MCP 模式;cloud mode 仅支持 cloud dry-run 和 image 策略。func.buildStrategy 省略或为 zip 时按传统代码包部署。危险操作需要显式 confirm=true。 **个人版 TCR 凭证**:imageType=personal 的 local/cloud 构建需要推送凭证。若 MCP 配置的 env 中已设置 TCB_TCR_USERNAME 与 TCB_TCR_PASSWORD(与 TENCENTCLOUD_SECRETID 等密钥同样的配置方式),则不需要在请求参数中传递 func.imageConfig.build.registryCredential,留空即可自动读取。不要向用户索要密码明文,也不要把密码写进工具参数。 注意这条 env 通道只在**本地 stdio MCP、且客户端的 mcp.json 支持自定义 env 块**时可用:部分 GUI 客户端不继承 shell 的 export,IDE 内置型 MCP 的凭据注入通常是硬编码白名单(例如只放行 TENCENTCLOUD_*),这类用户没有配置自定义 env 的通道,「在 MCP 配置的 env 中设置」对他们是无效指引。面向内置 MCP 用户应改为引导:使用企业版(imageType=enterprise,走实例临时令牌,不需要固定密码),或改用 buildStrategy=image 直接部署已推送的镜像。 **企业版登录态要求**:enterprise 的 cloud/local 构建要经 CAM 铸造 TCR 临时令牌,环境级 API Key 与 OAuth 换出的临时凭据都不带 CAM 策略,会被前置拦截并提示改用账号级密钥或 image 策略;个人版走静态密码直接 docker login,不经过 CAM,反而是 API Key 用户唯一能走通的构建路径。 **层(Layer)说明**: - 层为 SCF 账号级共享命名空间:不同环境创建同名层会共享同一层的版本序列;删除某版本会影响所有绑定该版本的环境的函数 - 创建层必须用带环境标识的唯一层名,固定格式:`{layerName}_{当前envId}`(如 `common_cloud1-d9ghadgak3edf6b36`)。不要在不同环境使用相同裸层名,创建前先 `listLayers` 查重 - 相关 action:`createLayerVersion` / `deleteLayerVersion` / `attachLayer` / `detachLayer` / `updateFunctionLayers`(只读查询见 queryFunctions 的 listLayers / listLayerVersions / getLayerVersionDetail) | アクション |
| queryHosting | 查询 CloudBase 静态托管的只读信息。适合 AI 先做发现再决定下一步:action=websiteConfig 查询首页/错误页/路由规则与站点域名信息;action=status 查询托管服务状态;action=findFiles 按前缀查找文件;action=listFiles 列出全部托管文件;action=domainStatus 查询自定义域名的当前状态与配置。该工具不会产生任何副作用。 | 読み取り専用 |
| manageHosting | 管理 CloudBase 静态托管的变更操作。action=upload 上传本地构建产物到共享域名(域名格式:<envId>-<appId>.tcloudbaseapp.com/<cloudPath>);action=delete 删除托管文件或目录(必须 confirm=true);action=setWebsiteDocument 设置首页/错误页/路由规则;action=enableService 开通静态托管;action=bindDomain / unbindDomain / updateDomain 管理自定义域名;action=downloadFile / downloadDirectory 下载托管内容到本地。⚠️ 底层每次托管操作都会请求 DescribeStaticStore 管控接口(20 次/秒 QPS 限制):批量删除多个文件请逐次调用并保持间隔(建议每秒不超过 10 次),同一目录下多个文件可优先用 isDir=true 一次删除整个目录;若报错含 "frequency limit" 说明触发了限流,请等待 1-2 秒后重试,不要连续快速重试。⚠️ 本工具没有关闭默认域名(*.tcloudbaseapp.com)的 action;要禁用该默认公网域名,请用 manageGateway(action="disableRoute", domain=该 STATIC_STORE IsDefault 域名, path="/")(底层 ModifyHTTPServiceRoute,不是 ModifyGatewayRoute)。⚠️ 新项目部署优先使用 manageApps(部署到独立子域名),本工具适合已有老项目继续使用或作为 manageApps 的 fallback。manageApps 与 manageHosting 域名不同,切换会导致老链接失效。若任务只是查看配置、文件或域名状态,请改用 queryHosting。 | アクション |
| queryStorage | ⚠️ PG 模式环境请使用 queryPgStorage 而非本工具(pgstore 与旧 COS 是两套独立系统)。 查询 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/`。 | 読み取り専用 |
| manageStorage | ⚠️ PG 模式环境请使用 queryPgStorage 而非本工具(pgstore 与旧 COS 是两套独立系统)。 管理 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_FOUND` 或 `PUT https://undefined/`(DevTools 表现为 `net::ERR_NAME_NOT_RESOLVED`),先用本工具或控制台确认 / 创建对应的 pgstore bucket,再让前端重试上传,不要让前端把上传失败静默吞掉。`DescribeEnvs.Storages[]` 返回的旧 NoSQL bucket(形如 `<hash>-<envId>-<appId>`)不是可用的 pgstore bucket,切勿当作默认目标使用。 | アクション |
| 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、CodeBuddy、Claude Code 等主流编辑器),适合在已有项目中补充AI编辑器配置 支持的IDE类型: - all: 下载所有IDE配置 - cursor: Cursor AI编辑器 - codebuddy: CodeBuddy AI编辑器 - claude-code: Claude Code AI编辑器 - gemini-cli: Gemini CLI - opencode: OpenCode AI编辑器 - qwen-code: 通义灵码 - baidu-comate: 百度Comate - openai-codex-cli: OpenAI Codex CLI - github-copilot: GitHub Copilot - roocode: RooCode AI编辑器(仅 MCP 配置,不含规则文件) - tongyi-lingma: 通义灵码 - trae: Trae AI编辑器 - qoder: Qoder AI编辑器 - antigravity: Google Antigravity AI编辑器 - vscode: Visual Studio Code - kiro: Kiro AI编辑器(仅 MCP 配置,不含规则文件) - aider: Aider AI编辑器 - iflow-cli: iFlow CLI(仅 MCP 配置,不含规则文件) 注意:如果未传入 ide 参数且无法从环境变量检测到 IDE,将提示错误并要求传入 ide 参数 特别说明: - rules 模板会自动包含当前 MCP 版本号信息,便于后续维护和版本追踪 - 下载 rules 模板时,如果项目中已存在 README.md 文件,系统会自动保护该文件不被覆盖(除非设置 overwrite=true) | アクション |
| searchKnowledgeBase | 云开发知识库检索工具,支持 CloudBase 官方文档 (docs)、固定技能文档 (skill) 和 OpenAPI 文档 (openapi) 查询。 按场景选择 mode: - 工具调用报错且错误信息含具体错误码(如 OperationDenied.FreePackageDenied)时:mode=docs + action=searchDocs(query=错误码),先查错误码官方含义与处理指引再行动,不要凭猜测重试 - 不确定答案在哪、需要对官方文档做全文检索时:mode=docs + action=searchDocs(传 query 关键词) - 已知文档标题、层级路径或 URL 时:mode=docs + action=findByName(传 input)或 action=readDoc(传 docPath) - 需要某个场景的落地指南 / 最佳实践时:mode=skill + skillName - 需要 HTTP API 的接口定义时:mode=openapi + apiName ⚠️ 重要:当 CloudBase skills 处于禁用状态或当前 IDE 不支持 skill 文件读取时,必须使用 searchKnowledgeBase(mode=skill, skillName=...) 来获取 CloudBase 技能文档内容,而不是尝试直接读取 skill 文件。直接读取可能返回 400 错误。示例: - 需要最小 Web+数据库 Demo 路径时:searchKnowledgeBase(mode=skill, skillName=minimal-web-baas-demo) - 需要 auth-tool-cloudbase 指南时:searchKnowledgeBase(mode=skill, skillName=auth-tool-cloudbase) - 需要 auth-web-cloudbase 指南时:searchKnowledgeBase(mode=skill, skillName=auth-web-cloudbase) - 需要 cloudbase-agent 指南时:searchKnowledgeBase(mode=skill, skillName=cloudbase-agent) - 需要 MCP 接入方式(本地 / 远程)、用 mcporter 在命令行调用工具、或站点 / 插件开关时:searchKnowledgeBase(mode=skill, skillName=cloudbase-mcp) 返回内容包含该 skill 的 SKILL.md 全文,以及它在远端聚合仓(CNB raw)中的全部 .md 文件地址清单(SKILL.md 与 references/ 等,可直接 HTTP 抓取)。正文中代码栅栏之外的相对链接也会改写为绝对地址;若该 skill 在远端仓中不存在,则只返回内联内容并明确标注,不返回失效链接。 不确定该选哪个时:mode=skill 下不传 skillName、mode=openapi 下不传 apiName 直接调用,会返回当前可用清单及各自的适用场景 / 接口简介,再带上名称重新调用即可。可选名称也见本工具的 skillName / apiName 枚举(skill 共 0 个,API 共 0 个)。 注意:OpenAPI 文档 (openapi) 查询只需要传 mode="openapi" 和 apiName,不要传 action;action 仅用于 mode="docs"。 | 読み取り専用 |
| queryCloudRun | 查询云托管服务信息,支持获取服务列表、查询服务详情、获取可用模板列表、获取构建日志(getDeployLog,仅云端源码构建/依赖 CODING)、获取运行日志(getProcessLog,镜像与源码部署均可/不依赖 CODING)、获取部署记录以及查询环境云托管开通状态(envStatus)。返回的服务信息包括服务名称、状态、访问类型、配置详情以及最近部署上下文。 | 読み取り専用 |
| manageCloudRun | 管理云托管服务,按开发顺序支持:开通云托管环境(initEnv)、初始化项目(可从模板开始,模板列表可通过 queryCloudRun 查询)、下载服务代码、本地运行(仅函数型服务)、部署代码、仅更新配置(updateConfig,无需重新上传代码)、删除服务。deploy 支持两种方式:1) 源码构建(传入 targetPath,本地代码打包上传,默认路径);2) 已有镜像部署(传入 imageUrl,如 ccr.ccs.tencentyun.com/ns/img:v1,走 DeployType=image 容器型部署,targetPath 可省略)。deploy 语义为「触发部署 + 轻量等待任务注册」(最多约 45s;不需要 buildId 时可传 waitRegistration=false 跳过等待)。源码构建返回 buildId,用 getDeployLog 轮询构建进度后再 getProcessLog;镜像部署(imageUrl)BuildId 常为 0,跳过 getDeployLog,返回 runId/next_step 引导 getProcessLog(或先 getDeployRecords 取 RunId)。若用户明确指定镜像或无需重新构建,必须传 imageUrl,不要仅因本地有源码目录就回退到源码构建。deploy 对已存在服务会先读取远程配置再合并(保留 VpcConf/EnvParams/OpenAccessTypes)。updateConfig 对齐控制台服务设置页。删除操作需要确认,建议设置force=true。新环境首次部署前若提示未开通云托管,先调用 initEnv 开通(异步、幂等)。部署前请确认镜像里没有静态内容:媒体文件(视频、大图、字体)、用户上传的文件、以及频繁更新的静态资源,都应放进云存储按 URL 引用,不要打进镜像——否则每次部署都要全量重推、每个扩容实例都要重拉,一个 demo 视频就能把 30 秒的部署拖成几分钟。 | アクション |
| deployBuild | 解析 cloudbaserc 并对 hosting[] 中配置了 buildCommand 的项目执行本地构建(仅执行 buildCommand,不安装依赖、不上传)。只处理 hosting[],不处理 cloudbaserc 的 app 资源 —— app 的产物需要你自己在项目目录构建(产物目录与构建命令可从 deployPlan 的 buildHint 读取),或改用 CLI `tcb app deploy` 走云端构建。声明式 hosting 部署拆分为「build → plan → apply」三步,本工具是第一步:先本地构建产物,再 deployPlan 预演,最后 deployApply 上传产物。deployApply 对 app 与 hosting 都不构建 —— 产物缺失时报 BUILD_OUTPUT_NOT_FOUND,hosting 可用本工具补齐,app 需你自行构建。纯静态托管(未配置 buildCommand 且无法探测框架)自动跳过。构建为纯本地操作:不解析环境、不要求登录,也不需要 confirm。 - cwd:项目根目录,默认当前工作目录 - mode:环境名,命中 envOverrides.<mode> 时合并对应的多环境覆盖配置 | アクション |
| deployPlan | 解析 cloudbaserc 并计算声明式部署计划(dry-run,不产生任何变更)。这是 deployApply 的预演对仗工具:plan 计算、deployApply 执行同一份 cloudbaserc。返回每个资源的动作分类:create=新建,update=覆盖更新,skip=无变更/不会执行,conflict=检测到冲突需中断,deploy=直传覆盖。计划已按 yes 复算为「实际会发生的动作」:不传 yes=true 时,云端已存在的函数会标为 skip(并在 declaredStatus 保留 update),与 deployApply 的实际执行结果一致,避免预演与执行相反。 ⚠️ app / hosting 的计划项一律是「直传已有产物」:声明式部署只部署不构建,cloudbaserc 的 buildCommand / framework 只用于推断产物目录,不会被执行。 app / hosting 的计划项带 buildHint = { buildCommand, outputDir, artifactReady }(机器可读,不要去解析 details 里的中文文案):artifactReady=false 表示产物目录缺失或为空,此时 deployApply 必定失败(BUILD_OUTPUT_NOT_FOUND)。正确做法是先构建再 apply —— hosting 可调用 deployBuild;app 需在项目目录执行 buildHint.buildCommand(为 null 则本就无需构建)。构建完成后重新 deployPlan 确认 artifactReady=true,不要改配置绕过。 适用边界:本工具用于项目级声明式编排(一份 cloudbaserc 统一 plan/apply);单资源临时直传请用 manageFunctions/manageHosting/manageApps。 - cwd:项目根目录,默认当前工作目录 - mode:环境名,命中 envOverrides.<mode> 时合并对应的多环境覆盖配置 - envId:目标环境 ID,优先级高于 cloudbaserc 中的 envId;不传则用配置值或当前绑定环境 - only:仅计算指定资源类型的计划 - skip:跳过指定资源类型 - yes:与 deployApply 的 yes 对齐,用于复算已存在函数的有效动作。true=预演为覆盖更新(update);false(默认)=预演为保守跳过(skip) | 読み取り専用 |
| deployApply | 解析 cloudbaserc 并按 database→functions→app→hosting→gateway 顺序执行声明式部署。这是 deployPlan 的执行对仗工具(plan 预演 / deployApply 执行同一份 cloudbaserc),属于本地形态的 apply(读本地 cloudbaserc 并把本地产物上传到云端),是会变更云端资源的写操作,必须显式传 confirm=true 才会执行。建议先用 deployPlan 预演,确认计划无误后再执行。 ⚠️ 只部署不构建:本工具不会执行任何构建命令(app 与 hosting 都不会)。cloudbaserc 里的 buildCommand / installCommand / framework 只用于推断产物目录,不会被执行。产物目录不存在或为空时报 BUILD_OUTPUT_NOT_FOUND —— hosting 先调 deployBuild,app 需让用户在项目目录执行其构建命令,完成后重试,不要改配置绕过。构建前可用 deployPlan 读取 buildHint.buildCommand / outputDir / artifactReady 确认该跑什么。app 需要云端构建时用 CLI `tcb app deploy`(本工具不提供云端构建)。 适用边界:本工具用于项目级声明式编排(一份 cloudbaserc 统一 plan/apply);单资源临时直传请用 manageFunctions/manageHosting/manageApps。 - confirm:必须显式传 true 才执行部署,否则直接拒绝 - confirmDestructive:当本次待执行的数据库迁移含破坏性语句(DROP/TRUNCATE/DELETE、ALTER…DROP/RENAME)时,除 confirm 外还必须显式传 confirmDestructive=true 才会执行;否则拒绝并列出命中的迁移与语句。无破坏性迁移时该参数不生效 - cwd:项目根目录,默认当前工作目录 - mode:环境名,命中 envOverrides.<mode> 时合并对应的多环境覆盖配置 - envId:目标环境 ID,优先级高于 cloudbaserc 中的 envId;不传则用配置值或当前绑定环境 - only:仅部署指定资源类型 - skip:跳过指定资源类型 - yes:遇到已存在资源时的处理方式。true=直接覆盖更新;false(默认)=保守跳过,在无法交互确认的场景下已存在资源不会被覆盖(与 deployPlan 的 yes 语义一致) - concurrency:同类型资源最大并行数,默认 1(串行) - continueOnError:某个资源失败后继续部署其余资源(database 失败仍强制中断) | アクション |
| queryGateway | CloudBase HTTP 网关统一只读入口(Domain/Route)。查询域名下路径路由及其上游:WEB_SCF/SCF=云函数,CBR=云托管,STATIC_STORE=静态托管,STORAGE=云存储,LH=轻量应用服务器。主键为 Domain + Path;listRoutes / getRoute / listCustomDomains / getPrivilege / cachePurgeTask。getPrivilege 查询 HTTP 网关总开关(enableService)与访问鉴权(enableAuth)状态。cachePurgeTask 查询域名缓存清除任务(先 manageGateway purgeCache 拿 TaskId)。实现自定义域名访问前,先 listCustomDomains:若已有自定义域名,优先 createRoute 挂路由(无需证书 ID);仅在没有可用自定义域名时才 bindCustomDomain。 | 読み取り専用 |
| manageGateway | CloudBase HTTP 网关统一写入口(Domain/Route)。createRoute/updateRoute/deleteRoute 把域名下的 path 转到上游;enableRoute/disableRoute 启用或禁用已有路由(底层 ModifyHTTPServiceRoute 的 Routes[].Enable,不是 ModifyGatewayRoute)。未传 domain 时用 DomainType=HTTPSERVICE 的 IsDefault 默认 HTTP 域名(形如 *.{region}.app.tcloudbase.com),不会使用静态托管 CDN 域名(*.tcloudbaseapp.com,DomainType=STATIC_STORE)。这是网关默认域上的路径路由,不是 STATIC_STORE 上游绑定;STATIC_STORE 上游必须显式传 upstreamResourceType=STATIC_STORE。关闭静态托管默认域名(*.tcloudbaseapp.com):先 queryGateway(listRoutes) 找到 DomainType=STATIC_STORE 且 IsDefault=true 的 domain,再 manageGateway(action="disableRoute", domain=该域名, path="/");勿用 manageHosting。创建后可用 queryGateway(action="listRoutes") 核对 Domain / DomainType / Path / UpstreamResourceType。上游类型只用一个参数 upstreamResourceType(也可写在 route.upstreamResourceType,route 优先):WEB_SCF=HTTP云函数,SCF=Event云函数,CBR=云托管,STATIC_STORE=静态托管,STORAGE=云存储,LH=轻量应用服务器;配合 targetName 或 route.serviceName(云函数名/云托管服务名/静态托管实例名,常见 staticstore/云存储实例名)。createRoute 只建网关入口,不改上游权限。enablePathTransmission:默认 false 剥触发路径前缀;true 透传完整路径(CBR 多路由、WEB_SCF 自管子路径常需 true;STATIC_STORE 自定义触发路径映射站点根通常 false)。⚠️ 自定义域名访问:若环境已有自定义域名(先 queryGateway listCustomDomains),优先 createRoute 并显式传入该 domain,无需 certificateId;仅首次绑定全新自定义域名时用 bindCustomDomain(certificateId 可选:未传时按域名自动检索证书,单证书自动选用、多证书返回选择指引)。createRoute / bindCustomDomain 创建前会调用 VerifyHTTPServiceRoute 做归属权等预检(探测→创建);失败时返回 data.checks 与 DNS TXT 指引,配置后重试。CORS/安全域名(浏览器跨域白名单,与本工具的网关自定义域名无关)用 manageEnv(action=addSecurityDomain/removeSecurityDomain)。enableService/authSwitch:HTTP 网关总开关与访问鉴权开关;createRoute 后若访问报 HTTPSERVICE_NONACTIVATED,通常是总开关未开启(用 queryGateway getPrivilege 查询、enableService 开启)。purgeCache:清除域名缓存(CDN/EO,按 URL/前缀/整站),返回 TaskId 后用 queryGateway cachePurgeTask 查进度。路由级还支持 enableSafeDomain(跨域/合法域名校验)、pathRewrite(路径重写)、qpsPolicy(限频)、extension(自定义请求/响应头与缓存规则);域名级支持 protocol 与 domainExtension。updateRoute 只传要改的字段即可,未传的 CORS/重写/限频/扩展配置会保持原值。 | アクション |
| 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。 | 読み取り専用 |
| manageAppAuth | CloudBase 应用侧认证配置写入口。用于修改登录方式、provider、client 配置,确保 publishable key,以及创建或删除 API key、自定义登录密钥。⚠️ 本工具为管理端配置工具,不执行用户登录。当任务要求编写客户端登录代码时(例如「用 JS SDK 登录」),应先通过本工具完成配置(如启用 usernamePassword、获取 publishable key),再在项目代码中编写 @cloudbase/js-sdk 客户端登录代码(如 auth.signInWithPassword()),而非使用本工具完成登录。若前端要接受普通用户名样式标识符,应先执行 action=patchLoginStrategy 并传入 patch={ usernamePassword: true },再实现对应前端登录逻辑。⚠️ 短信验证码登录(patch={ phone: true })使用云开发默认短信通道,开启后即可收发验证码,不需要配置短信签名/模板/自定义 Provider;仅当需要自定义模板/签名或更换短信服务商时才需配置 SmsVerificationConfig 或自定义短信通道。⚠️ action=createApiKey 返回体中的 created 字段表示是否真正新建:created=false 说明复用了环境中已存在的 key,此时 keyName/expireIn 入参不会生效,返回的 keyName/expireAt 均为服务端真实值,并会附带 warnings,切勿把它当作临时凭证分发。 | アクション |
| queryApps | 查询 CloudBase 应用部署的应用和版本。可查应用列表/详情、版本列表/详情;部署后用 getAppVersion 按 buildId 轮询构建状态;getBuildLog 可查询构建日志用于诊断失败原因。 action=getUploadUrl(只读)可获取预签名上传 URL:无本地文件系统时(cloud mode),先拿到 uploadUrl 自行 PUT 代码 zip,再用返回的 unixTimestamp 调 manageApps(action=deployApp, cosTimestamp) 触发部署。uploadUrl 是一次性上传凭据,不要外传或写进工单。 | 読み取り専用 |
| manageApps | 部署 Web 应用到 CloudBase(构建前后端,部署到独立子域名)。 云端上传通道(cloud mode,无本地文件系统):queryApps(action=getUploadUrl) 或 manageApps(action=getUploadUrl) 获取预签名上传 URL → agent 自行 PUT 代码 zip 到 uploadUrl(带 uploadHeaders 与 Content-Type: application/zip)→ 用返回的 unixTimestamp 作为 cosTimestamp 调 deployApp 触发部署。 action=getUploadUrl 获取预签名上传 URL(cloud mode 下使用),返回上传地址和 cosTimestamp。 action=deployApp 上传源码 ZIP 并触发远端构建部署管道: 1. 远端 npm install(可通过 installCmd="" 跳过) 2. 远端 npm run build(可通过 buildCmd="" 跳过) 3. 远端 tcb hosting deploy 域名格式:`<serviceName>-<envId>.webapps.tcloudbase.com`(每个 serviceName 一个独立子域名) ✅ 推荐用法(新项目/需要独立域名的 Web 应用,首选此工具): 新建项目首次部署时,传 framework=static, installCmd="", buildCmd="" 跳过远端构建, 只执行 tcb hosting deploy。部署后获得独立子域名,支持版本管理。 ⚠️ 兼容性说明: - 已有项目若之前用 manageHosting 部署过(域名格式:`<envId>-<appId>.tcloudbaseapp.com`), 切换到 manageApps 会产生全新的 URL,老链接失效。请保持原部署方式不变。 - 如需判断:调用 queryHosting 检查是否已有托管文件。 与 manageHosting 对比: - manageApps(本工具,新项目首选):域名 `<serviceName>-<envId>.webapps.tcloudbase.com`,独立子域名,支持版本管理 - manageHosting(已有项目或 fallback):域名 `<envId>-<appId>.tcloudbaseapp.com/<path>`,共享环境域名 两者均可绑定自定义域名。 ⚠️ 如果 manageApps 构建失败,先用 queryApps(action="getBuildLog") 查日志;仍不行再 fallback 到 manageHosting。 | アクション |
| queryPermissions | 查询 CloudBase 权限与用户配置,支持查询资源权限(数据库/云函数/存储桶等)、角色列表/详情、应用用户列表/详情,以及网关 OPA 授权策略(对齐 CLI `tcb policy list/get`)。 示例: - 查询存储桶权限:`action="getResourcePermission", resourceType="storage", resourceId="bucket-name"` - 列出旧网关策略:`action="listPolicy"`(只有真实查询为空才等于「没有策略」;PG / OPA 引擎环境会跳过查询,返回 `skipped=true` 与空列表,**不代表没有策略**,请改用 getPolicy) - 读取用户 Rego:`action="getPolicy"`;平台扩展策略:`action="getPolicy", extension=true` 📌 跨后端边界提示:调用前先用 `queryEnv(action="info", envId=...)` 看 `EnvInfo.RuntimeBackends`。`resourceType="noSqlDatabase"` 查询的是 CloudBase NoSQL 集合规则,与 CloudBase PostgreSQL(PG)表的行级安全(RLS)是两套独立机制——同一个 PG 环境里 NoSQL 集合若仍在使用,对那些集合查询本工具结果**仍然有效**。要查 PG 表 RLS,请改用 `queryPgDatabase(action="sql", sql="SELECT * FROM pg_policies WHERE tablename=...")`。本工具不涉及 MySQL 权限。 ⚠️ PostgreSQL 环境:平台 `DescribeResourcePermission` 对 PG 环境会直接拒绝。当 `resourceType="function"` 时,本工具会自动回退到 Manager SDK `describeEnvAuthzConfig`(与 CLI `tcb policy get` 一致,读取 `authz.user.rego`)。显式 OPA 策略请用 `listPolicy` / `getPolicy`。 ⚠️ 角色类 action(`listRoles` / `getRole`)在 **PostgreSQL 类型环境**下平台侧一律拒绝(`The current API does not support PostgreSQL type environments.`)——这是平台能力边界,不是配置问题,**不要在 PG 环境反复重试**;PG 环境请改用 RLS(`managePgDatabase(action="execute")` 跑 `CREATE POLICY`)或控制台管理权限。 | 読み取り専用 |
| managePermissions | 管理 CloudBase 权限与用户配置,支持修改资源权限(数据库/云函数/存储桶等)、角色管理、成员与策略增删、应用用户 CRUD,以及设置网关 OPA Rego 策略(对齐 CLI `tcb policy set`)。 示例: - 设置存储桶为私有:`action="updateResourcePermission", resourceType="storage", resourceId="bucket-name", permission="PRIVATE"` - 创建角色:`action="createRole", roleName="admin", roleIdentity="admin"` - 放开云函数匿名/未登录访问(PG 会走 OPA,对齐 CLI `tcb policy set`):`action="updateResourcePermission", resourceType="function", resourceId="myFn", permission="CUSTOM", securityRule='{"invoke":true}'` - 直接设置用户 Rego:`action="setPolicy", regoContent="package authz.user\n\ndefault allow := false\n", confirm=true`(⚠️ 立即禁用旧网关鉴权) 注意:`createUser` / `updateUser` 是环境侧应用用户管理能力,适合测试账号、管理员或预置用户,不应替代浏览器里的 Web SDK 注册表单;前端用户名密码注册应使用 `auth.signUp({ username, password })`,登录应使用 `auth.signInWithPassword({ username, password })`。直接在浏览器里用 `auth.signUp` 创建用户名密码用户取决于 SDK/provider 支持,使用前必须验证;不支持时应走后端或管理端边界,不能在浏览器暴露密钥。`securityRule` 的详细语义取决于 `resourceType`:`doc._openid`、`auth.openid`、查询条件子集校验,以及 `create` / `update` / `delete` JSON 模板仅适用于 `resourceType="noSqlDatabase"` 的文档数据库安全规则;配置 `function` 或 `storage` 时,请参考各自官方安全规则文档,而不是复用 NoSQL 模板。 📌 跨后端边界提示:调用前先用 `queryEnv(action="info", envId=...)` 看 `EnvInfo.RuntimeBackends`: - `resourceType="noSqlDatabase"` 仅作用于 CloudBase NoSQL 文档数据库的集合;CloudBase PostgreSQL(PG)表的行级权限**不**受它控制——PG 表请改用 RLS:`managePgDatabase(action="execute", confirm=true)` 跑 `ALTER TABLE ... ENABLE ROW LEVEL SECURITY` 与 `CREATE POLICY ...`。同一个 PG 环境里如果还有 NoSQL 集合在用,对那些**集合**继续使用 `noSqlDatabase` 规则是正确的——不是"PG 环境就禁用本工具"。 - `resourceType="storage"` 控制的是 NoSQL/COS 存储桶 ACL;PG 的 `pgstore` bucket 不在此 `resourceType` 覆盖范围内。 - 本工具不涉及 MySQL;MySQL 数据库权限请走 MySQL 自身的 GRANT/REVOKE 语句(通过 `manageMysqlDatabase`)。 ⚠️ PostgreSQL 环境:平台 `ModifyResourcePermission` 对 PG 环境会直接拒绝。当 `resourceType="function"` 时,本工具会自动回退到 Manager SDK `modifyEnvAuthzConfig`(与 CLI `tcb policy set` 一致,写入 `authz.user.rego`)。`securityRule` 可传完整 Rego(`package authz.user`)或 `'{"invoke":true}'`(自动生成放通 anonymous/unauthenticated 调 functions 的策略)。设置 Rego 后会替换该环境整个用户策略文档(对全环境生效,不是单个函数/资源),旧网关鉴权立即失效且不会回退,与 CLI 行为一致。显式 OPA 策略请优先用 `action="setPolicy"`。 ⚠️ 角色类 action(`createRole` / `deleteRoles` / `updateRole`)在 **PostgreSQL 类型环境**下平台侧一律拒绝(`The current API does not support PostgreSQL type environments.`)——平台能力边界,不是配置问题,**不要在 PG 环境反复重试**;PG 环境请改用 RLS(`managePgDatabase(action="execute")` 跑 `CREATE POLICY`)或控制台管理权限。 | アクション |
| queryLogs | CloudBase 日志域统一只读入口。支持检查日志服务状态并搜索 CLS 日志。 **重要区分**: - 查询云函数日志:使用 `queryFunctions(action="listFunctionLogs", functionName="xxx")` - 查询 CLS 日志(跨服务日志聚合):使用本工具 `queryLogs(action="searchLogs")` - 开通 CLS 日志服务:使用 `manageLogs(action="createLogService", confirm=true)` **适用场景**: - 检查 CLS 日志服务是否开通:`action="checkLogService"` - 跨服务日志搜索(如搜索所有 ERROR 日志):`action="searchLogs"` - 按 CLS 语法检索特定服务的日志:`action="searchLogs", service="tcb|tcbr"` | 読み取り専用 |
| manageLogs | CloudBase 日志域写入入口。用于开通 CLS 日志服务(对齐 Manager SDK `log.createLogService` / CreateEnvResource Resources=['log'])。 **适用场景**: - 开通 CLS 日志服务:`action="createLogService", confirm=true` 开通为异步操作:接口成功不代表立即可用,请随后用 `queryLogs(action="checkLogService")` 轮询确认。 | アクション |
| queryAgents | CloudBase Agent 域统一只读入口。支持列表、详情与日志查询。 | 読み取り専用 |
| manageAgents | CloudBase Agent 域统一写入口。支持创建、更新和删除远端 Agent。 | アクション |
| callCloudApi | 通用的云 API 调用工具,主要用于 CloudBase / 腾讯云管控面与依赖资源相关 API 调用。**调用前必读接口索引** https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/api-reference.md (每日自动同步的 Action 级索引,含 rate limit;先查此索引确认 service/Action/参数,避免猜测 Action 名称;索引未覆盖的产品再去该产品官方 API 文档核对)。如果你的目标是通过 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 分类如下: **环境管理**: `CreateEnv`、`ModifyEnv`、`DescribeEnvs`、`DestroyEnv` **用户管理**: `CreateUser`、`ModifyUser`、`DescribeUserList`、`DeleteUsers` **认证配置**: `EditAuthConfig`、`DescribeAuthDomains` **云函数**: `DescribeFunctions`、`CreateFunction`、`UpdateFunctionCode`、`DeleteFunction` **数据库**: `CreateMySQLInstance`、`DescribeMySQLInstances`、`DestroyMySQLInstance` ⚠️ 云托管(CloudBase Run)统一走 tcbr service(CreateCloudRunEnv / CreateCloudRunServer / DescribeEnvBaseInfo / DescribeCloudRunEnvs,version="2022-02-17"),tcb 旧小租户接口 CreateCloudBaseRunResource 等已被禁用;部署请用 manageCloudRun。查询单个环境基础信息/是否已开通云托管用 DescribeEnvBaseInfo(EnvId 必填),查询环境列表及资源信息用 DescribeCloudRunEnvs(EnvId 可选过滤)。 ⚠️ Region 必须作为本工具顶层参数 `region` 传入(对应 X-TC-Region / 地域 endpoint),不要放进 params。params 里的 Region 会被剥离并当作顶层 region 使用。 销毁环境时,常见做法是至少带上 `EnvId` 和 `BypassCheck: true`,如果环境已经处于隔离期再按文档补 `IsForce: true`。 | アクション |
| prepareFeedback | 返回公开仓库的新建 issue 页面。 **什么时候用**: - `channel="case"`:作品已经做出来,用户想展示到案例墙。 - `channel="retrospective"`:这次开发不顺利,用户想把卡点反馈给平台。 **怎么用**: - 只调用一次。返回的是页面地址,不是已提交的 issue。 - 在对话里写好正文,把链接交给用户。用户登录后自己提交。 - 不要代为提交,不要把环境 ID 或密钥写进正文。 | 読み取り専用 |
自動チェック
実行日 2026年11月16日完全なレポート →自動チェックに合格しました。これはセキュリティ監査ではありません。コードを読み、サーバーに必要最小限のアクセス権を与えてください。 チェックの仕組み
- ソースリポジトリがリンクされており、アクセス可能tencentcloudbase/cloudbase-ai-toolkit is public and reachablegithub.com/tencentcloudbase/cloudbase-ai-toolkit ↗合格
- パッケージがこのリポジトリをソースとして指定@cloudbase/cloudbase-mcp names tencentcloudbase/cloudbase-ai-toolkit as sourcenpmjs.com/package/@cloudbase/cloudbase-mcp ↗合格
- ビルドの来歴 (Sigstore 証明)Sigstore attestation for @cloudbase/cloudbase-mcpnpmjs.com/package/@cloudbase/cloudbase-mcp/v/2.37.7#provenan ↗合格
- オープンソースライセンス (OSI)MITspdx.org/licenses/MIT.html ↗合格
- 過去1年以内にコミットまたはリリースありLast commit or release 2026-11-16github.com/tencentcloudbase/cloudbase-ai-toolkit ↗合格
- OpenSSF Scorecard未チェック
- パッケージ名が有名なパッケージに酷似していないNo popular package one edit away from @cloudbase/cloudbase-mcp合格
- パッケージおよびその依存関係に重大な勧告なしthe package checked; no critical advisoryosv.dev ↗合格
- モデルへの隠れた指示がない42 tool descriptions and the README read; no override phrases, credential paths or hidden characters合格
- 破壊的なツールがラベル付けされているNo tool named like delete, drop or exec合格
- リモートエンドポイントが MCP ハンドシェイクに応答HTTPS endpoint answered 401 (sign-in required)合格
README
GitHubで見る@cloudbase/cloudbase-mcp
MCP Server for Tencent CloudBase. Part of CloudBase AI Toolkit.
Operate CloudBase from AI coding tools: login, databases, functions, storage, hosting, and logs—via the Model Context Protocol.
English · 简体中文 · Toolkit README · Docs · Changelog · Issues
What this package is
@cloudbase/cloudbase-mcp is the npm distribution of the CloudBase MCP Server. It is one piece of the Toolkit:
| Piece | Role |
|---|---|
| Plugin | Installs MCP + Skills + Hooks together |
| Agent Skills | Scenario skills toward workable CloudBase practice |
| MCP (this package) | Tools the agent calls to act on your CloudBase environment |
Prefer Plugin when your IDE supports it. Use this package alone when you only need MCP config.
Full Toolkit narrative, related repos, and IDE matrix: repository README.
Quick start
{
"mcpServers": {
"cloudbase": {
"command": "npx",
"args": ["-y", "@cloudbase/npm-launcher@1.0.0", "@cloudbase/cloudbase-mcp@latest"]
}
}
}
First prompts:
Login to CloudBase
Use CloudBase Skills to build a todo app with login, database and permissions, then deploy
You need a CloudBase environment and should confirm sensitive actions the AI proposes.
Other install paths
| Path | When |
|---|---|
Official MCP Registry io.github.TencentCloudBase/cloudbase-mcp |
Discover via registry search=cloudbase |
npx plugins add TencentCloudBase/cloudbase-plugin |
Open Plugin Spec tools |
| Marketplace / built-in plugin | Claude Code, Codex, CodeBuddy, WorkBuddy, Doubao, MiniMax Code, DeepSeek Harness, Kimi Code, Kimi Work, ZCode, etc. |
Already using CloudBase CLI?
tcb aisets up MCP and Skills too (docs).
Connection modes
Remote (recommended): your IDE connects over HTTP to Tencent Cloud MCP. No local Node, and interactive clients finish authorization in the browser.
| Site | MCP endpoint |
|---|---|
| China (domestic) | https://tcb-api.cloud.tencent.com/mcp/v1 |
| International | https://tcb-api.tencentcloud.com/mcp/v1 |
Pick the endpoint matching the site your environment lives in—the two sites use separate accounts and credentials.
OAuth (interactive, recommended): the URL is the whole configuration—your IDE opens the browser for login and consent, and you pick the environment there. No keys land in config files, and there is nothing to rotate.
{
"mcpServers": {
"cloudbase": {
"type": "http",
"url": "https://tcb-api.cloud.tencent.com/mcp/v1"
}
}
}
Static credentials (for a client without OAuth, and for CI/CD): append env_id and a key pair created on the same site as the endpoint.
{
"mcpServers": {
"cloudbase": {
"type": "http",
"url": "https://tcb-api.cloud.tencent.com/mcp/v1?env_id=<env_id>",
"headers": {
"X-TencentCloud-SecretId": "<Tencent Cloud Secret ID>",
"X-TencentCloud-SecretKey": "<Tencent Cloud Secret Key>"
}
}
}
}
A static key pair stays valid until it is rotated or deleted; an OAuth session ends when you log out. Use the static form only where the browser flow is impossible—and keep it out of a repository.
Local: runs npx -y @cloudbase/npm-launcher@1.0.0 @cloudbase/cloudbase-mcp@latest on your machine—full features, including local filesystem upload and template download. Requires Node.js v18.15.0+.
Remote trade-off: local-filesystem features (upload, template download) are unavailable, and the international site does not yet expose NoSQL tools.
Remote URLs accept site for one case only—a China-site environment in ap-singapore, where the region is ambiguous—plus enable_plugins / disable_plugins (comma-separated). Canonical plugin names: see src/server.ts in this package (e.g. env, database, functions, hosting, storage, pg_database, cloudrun, logs, feedback).
Self-hosted Cloud Mode: set CLOUDBASE_MCP_CLOUD_MODE=true (or MCP_CLOUD_MODE=true) so local file and process tools are disabled for remote callers.
| Scenario | Suggestion |
|---|---|
| Personal / fastest start | Remote URL (OAuth) |
| Need local file features | Local npx |
| CI / automation | Remote + static credentials |
| Self-hosted MCP | Cloud Mode required |
Site & region
Set TCB_SITE (domestic / intl) to select the login/credential site, and TCB_REGION for API routing. The domestic and international sites are separate account systems. ap-singapore exists on both, so domestic-site Singapore users must set TCB_SITE=domestic; otherwise it defaults to intl. Project-level .cloudbase/project.json ({ site, region, envId }) is also supported.
In remote mode the site is determined by the endpoint host itself—tcb-api.cloud.tencent.com is the China site, tcb-api.tencentcloud.com is the international site—and there is no site query parameter to set. This holds for a China-site environment in ap-singapore too: keep using the China-site endpoint. Self-hosted Cloud Mode deployments can still use the TCB_SITE environment variable.
MCP Apps panels (on by default)
auth, queryEnv and the deploy tools can render MCP Apps panels (ui://cloudbase/*) in hosts that support them. Panels are on by default: the ui:// resources are registered and those tools carry _meta.ui.
Hosts that cannot render them are unaffected in practice — resources/list stays empty (the panels are ResourceTemplates without a list), so nothing new appears in a resource browser, and every tool keeps returning the same JSON text it did before. The flag only decides whether panels are offered.
Turn it off with CLOUDBASE_MCP_UI=off (also accepts 0 / false / no / disabled). Leaving it unset means on; a typo such as of also leaves it off, so a misspelled value never silently enables something you meant to disable. Tools behave identically either way.
Capabilities
Typical backend work in your environment (confirm critical steps):
- Database: PostgreSQL and document DB, data models, CRUD, permissions
- Compute: cloud functions / Cloud Run—author, deploy, invoke, debug
- Auth & storage: login methods, object storage, permission linkage
- Release & ops: static hosting / Mini Program publish; logs and redeploy
Tool catalog: MCP tools · tools.json
Confirmations before destructive calls
Deleting a cloud function, a collection, the documents in one, a stored file, a CloudRun service or a MySQL instance now pauses
the call until you answer a dialog that names the target — "about to delete the cloud function hello (env env-abc)" — instead
of asking a bare "are you sure?". The same deletes pause when they arrive as callCloudApi, but only for an explicit
service + Action pair: DeleteFunction on tcb or scf, tcb.DeleteTable, tcb.DeleteItem, tcb.DestroyEnv, tcb.DestroyPlatformEnv, tcb.DestroyMySQL,
tcbr.DeleteCloudRunServer, and tcbr.DeleteCloudRunVersions when IsDeleteServer is true. A Delete prefix does not
confirm other cloud APIs. Cloud storage deletes do not go through callCloudApi. PostgreSQL execute / applyMigration pause only when the SQL itself is DELETE, DROP, TRUNCATE or ALTER … DROP; INSERT, UPDATE and CREATE TABLE do not. It is built on MCP form elicitation, so it
can only appear where the client declares that capability and actually asks the user.
| Situation | What happens |
|---|---|
| The client asks the user | You get the dialog; the call runs only after you pick "delete" |
| The client is in a full-access / never-ask mode | It answers on its own within a few milliseconds. That is treated as "you were not asked", and the call proceeds |
| The client cannot render forms | No dialog, and the call proceeds — the behaviour is the same as before this change |
| You decline, dismiss it, or answer nothing for 45s | Nothing is executed, and the result says so without being marked as an error, so a model does not retry the same deletion |
A declined call is not a failure: the tool returns "not executed" plus what to do instead. Two environment variables change the handling, and neither of them bypasses authentication, permissions or read-only limits — they only decide whether the question is asked:
| Variable | Effect |
|---|---|
CLOUDBASE_MCP_SKIP_ELICITATIONS |
Comma-separated. Accepts a tool name (manageFunctions, callCloudApi) or a single action (manageFunctions.deleteFunction, callCloudApi.tcb.DeleteFunction), case-sensitive, no wildcard. Unknown entries are logged and ignored rather than failing the server |
CLOUDBASE_MCP_ELICIT_AUTO_APPROVE |
allow (default) proceeds when the client answers for itself; block treats that case as not confirmed |
A client's own tool-approval prompt is not this confirmation: it asks "may this tool run?", not "is this the resource you want to delete?".
Credential-shaped arguments: one real check before writing
When a call's arguments contain something shaped like a credential — a three-part JWT, or a cb_secret_… / cb_publishable_…
key — the server asks the client for one check before writing: compare the value against your original source and confirm. The
message deliberately carries no plaintext: only the total length, the segment lengths (for a JWT), and a fingerprint (the first
12 hex characters of sha256). That is enough to notice a value that was changed while being copied or transcribed, and nothing that
would put the secret into the conversation or into the logs.
What this is not. We do not decide whether the credential is valid. There is no signature verification, no certs/JWKS lookup,
no network request of any kind, and no server-side comparison — the server never sees the value you originally pasted, so the only
side that can compare it is the client. This is a request for a real confirmation at write time, not a validity check.
Boundaries. It only applies when the arguments actually contain a credential-shaped string (otherwise the call is unchanged: one shallow scan, no network). It only applies when the client supports interactive form elicitation; a client that cannot ask proceeds as before, so an unattended client is not blocked. And a check that returns within a few hundred milliseconds counts as "nobody looked at it": unlike the deletion confirmation — where a client answering for itself is treated as "you were not asked" and the call proceeds — a credential write is not executed, because a value nobody compared is exactly the case this guards against. When the guard declines, the result says "not executed" without being marked as an error, so a model does not retry it blindly.
| Variable | Effect |
|---|---|
CLOUDBASE_MCP_SKIP_CREDENTIAL_GUARD |
Comma-separated. Accepts a tool name (manageCloudRun) or a single action (manageCloudRun.updateConfig), case-sensitive, no wildcard. Unknown entries are logged and ignored rather than failing the server |
Environment panel (MCP Apps)
The panel is on by default. Set CLOUDBASE_MCP_UI=off to hide it. Where the client declares the io.modelcontextprotocol/ui extension, auth also opens a panel
(ui://cloudbase/get-started). It consumes the structured result that this auth call already returned and shows
the connection status: region, scope, and the environment ID. Signed-out users get a sign-in action. When no environment is bound, clicking a row binds it.
The panel does not touch cloud resources, but it is not a read-only surface. It makes two kinds of calls:
auth(status)— read-only, fired by "Re-check".auth(set_env)— fired when you click an environment row. It only rebinds the local environment for this session (an environment-scoped API key still cannot reach another environment), but it changes which environment every subsequent tool call uses, so pick the row deliberately.
Every other action just hands a sentence to the conversation. A result that carries a credentials block
(for example auth(get_temp_credentials) with reveal) does not open "View raw response", so that fold
never shows the key.
Clients that do not render MCP Apps are unaffected: auth keeps the same title, description, arguments and
output, and resources/list stays empty, so nothing new appears in a resource browser.
IDE config snippets
{
"mcpServers": {
"cloudbase": {
"command": "npx",
"args": ["-y", "@cloudbase/npm-launcher@1.0.0", "@cloudbase/cloudbase-mcp@latest"]
}
}
}
{
"mcpServers": {
"cloudbase": {
"command": "npx",
"args": ["-y", "@cloudbase/npm-launcher@1.0.0", "@cloudbase/cloudbase-mcp@latest"]
}
}
}
CloudBase is built in; manual MCP config is usually unnecessary.
Others: IDE setup.
Docs
License
CloudBase MCPのよくある質問
CloudBase MCPをClaude Codeに追加するには
ターミナルでclaude mcp add cloudbase-mcp -- npx -y @cloudbase/cloudbase-mcpを実行します。すべてのプロジェクトで利用するには--scope userを追加します。
CloudBase MCPをCursorに追加するには
~/.cursor/mcp.jsonを開き、上記のインストールセクションに示すCursor設定を使ってmcpServersの下にサーバーを追加します。
CloudBase MCPが提供するツールは
42個のツールを提供しており、auth, queryEnv, envDomainManagement, manageEnv, readNoSqlDatabaseStructureなどがあります。
CloudBase MCP serverのインストール方法は?
npxを使用して、次のコマンドでインストールできます: npx -y @cloudbase/npm-launcher@1.0.0 @cloudbase/cloudbase-mcp@latest。
破壊的な操作に対するセキュリティ機能はありますか?
はい。関数の削除やデータベースの削除などの破壊的な呼び出しは、サーバーが一時停止し、ダイアログを通じて確認を求めます。
CloudBase MCPをCI/CDで使用できますか?
はい。自動化やCI/CDの目的で、静的な認証情報を使用したRemoteモードを利用できます。