CloudBase
NPM · @CLOUDBASE/CLOUDBASE-MCP · 3 COMPONENTS · SCANNED SEP 20
CloudBase MCP: DB, functions, storage, hosting via @cloudbase/cloudbase-mcp
How this component scores in each security and reliability category. Every signal is checked automatically from public evidence about the published package, including repeated runs of it in an isolated sandbox, and we only credit what we can confirm. How we score → Why this is hard to score →
Supply Chain Security100
- No malware found by supply-chain analysis.Pass
- No known CVEs affecting this package version or its production dependencies.Pass
- No install/post-install scripts declared.Pass
- No production dependencies, so there is no dependency health to assess. View diagnostics → Pass
Provenance & Transparency97
- Source repository is publicly reachable at the declared URL. View diagnostics → Pass
- Cryptographically verified build provenance (signed, bound to TencentCloudBase/CloudBase-AI-Toolkit). View diagnostics → Pass
- Clear OSI-approved license (MIT).Pass
- Actively maintained (last published 0 days ago).Pass
- Disclosure check failed: no security disclosure policy was found in the source repository. See how to fix → Fail
Schema Quality & AI Usability52
- AI-judged instruction clarity (good).Pass
- Context-footprint check failed: tool/resource definitions use about 29263 tokens (~731/item across 40 items; 40 tools + 0 resources), over budget; trim descriptions and params. See how to fix → Fail
- Usage-examples check failed: none of the tools include examples. See how to fix → Fail
Stability & Change Management85
- Stability check failed: the tool surface changed between 2.32.0 and 2.34.5: 1 tool removals, 2 breaking changes, 3 additions. See how to fix → Fail
Tool Coverage96
- 100% of tools have a non-trivial description (not blank, and not just the tool's name).Pass
- 87% of tool parameters carry a description.Partial
Tool Safety92
- No prompt-injection markers were found in the server instructions, tool names or descriptions we captured.Pass
- 2 of 3 tool(s) whose name or description implies an irreversible operation declare an MCP destructiveHint annotation; "deployPlan" implies "deploy" and declares readOnlyHint instead, contradicting what its own name says it does. See how to fix → Partial
- An AI judge read all 40 captured unit(s) of tool text and found none that tries to manipulate the model reading it.Pass
Capabilities100
- Implements a supported MCP spec version (2025-11-25); the latest is 2026-07-28.Pass
How do I install the CloudBase MCP server?
CloudBase runs locally as an npm package, launched with npx -y @cloudbase/cloudbase-mcp. Ready-made configuration for Claude, Cursor, VS Code, Codex and 5 more is on this page, copied from each client's own documentation.
npm · @cloudbase/cloudbase-mcp
claude mcp add tencentcloudbase-cloudbase-mcp -- npx -y @cloudbase/cloudbase-mcp
{
"mcpServers": {
"tencentcloudbase-cloudbase-mcp": {
"command": "npx",
"args": [
"-y",
"@cloudbase/cloudbase-mcp"
]
}
}
} {
"servers": {
"tencentcloudbase-cloudbase-mcp": {
"command": "npx",
"args": [
"-y",
"@cloudbase/cloudbase-mcp"
]
}
}
} codex mcp add tencentcloudbase-cloudbase-mcp -- npx -y @cloudbase/cloudbase-mcp
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"tencentcloudbase-cloudbase-mcp": {
"type": "local",
"command": [
"npx",
"-y",
"@cloudbase/cloudbase-mcp"
],
"enabled": true
}
}
} openclaw mcp add tencentcloudbase-cloudbase-mcp --command npx --arg -y --arg @cloudbase/cloudbase-mcp
mcp_servers:
tencentcloudbase-cloudbase-mcp:
command: "npx"
args: ["-y", "@cloudbase/cloudbase-mcp"] {
"McpServers": {
"tencentcloudbase-cloudbase-mcp": {
"Transport": "stdio",
"Command": "npx",
"Arguments": [
"-y",
"@cloudbase/cloudbase-mcp"
]
}
}
} assistant mcp add tencentcloudbase-cloudbase-mcp -t stdio -c npx -a -y @cloudbase/cloudbase-mcp
{
"mcpServers": {
"tencentcloudbase-cloudbase-mcp": {
"command": "npx",
"args": [
"-y",
"@cloudbase/cloudbase-mcp"
]
}
}
} Every change we have recorded for this component, newest first. Security-relevant changes are always shown. ▲ marks a change for the better, ▼ a change for the worse; unmarked changes are neutral.
- 20 Sept 26 −2
- Tool safety: pass → unverified ▼ security
- Stability: fail → unverified ▼ security
- Tool coverage: 100 → unverified ▼ functional
- Capabilities: pass → unverified ▼ functional
- First check of Schema quality: unverified functional
- Schema quality: excellent → good functional
- Package version: 2.34.4 → 2.34.5 functional
- 19 Sept 26 +1
No change was recorded against any check on this day. Stability & Change Management went from 94 to 97.
- 18 Sept 26 −1
No change was recorded against any check on this day. Stability & Change Management went from 97 to 94.
- 17 Sept 26 +27
- Malware scan: unverified → pass ▲ security
- Known CVEs: unverified → pass ▲ security
- Dependency health: unverified → pass ▲ functional
- 16 Sept 26 −25
- Malware scan: pass → unverified ▼ security
- Known CVEs: pass → unverified ▼ security
- Dependency health: pass → unverified ▼ functional
- Destructive annotations: 33% → 67% ▲ functional
- Package version: 2.34.3 → 2.34.4 functional
- 15 Sept 26 +15
- Malware scan: unverified → pass ▲ security
- 14 Sept 26 +12
- Known CVEs: unverified → pass ▲ security
- Dependency health: unverified → pass ▲ functional
- Package version: 2.34.2 → 2.34.3 functional
- 13 Sept 26 −26
- Known CVEs: pass → unverified ▼ security
- Malware scan: pass → unverified ▼ security
- Destructive annotations: 50% → 33% ▼ functional
- Dependency health: pass → unverified ▼ functional
- Package version: 2.33.2 → 2.34.2 functional
- Package version: 2.33.2 → 2.34.1 functional
- Package version: 2.33.2 → 2.34.0 functional
Diagnostic detail from the automated scan of this channel: what the scanner observed at each step, so you can see exactly where a check passed or failed. It is informational only and never changes the trust score.
Captured 20 Sept 2026 · Analysed npm/@cloudbase/cloudbase-mcp@2.34.5
Provenance Verified
A signed build attestation was found and verified, binding this exact artifact to the source repository it claims to come from.
| Result | Verified |
|---|---|
| Ecosystem | npm |
| Reason | Verified |
| Discovered via | Registry attestation endpoint |
| Source repo | TencentCloudBase/CloudBase-AI-Toolkit |
| Certificate issuer | https://token.actions.githubusercontent.com |
| Certificate SAN | https://github.com/TencentCloudBase/CloudBase-AI-Toolkit/.github/workflows/npm-publish.yaml@refs/tags/v2.34.5 |
| Rekor log index | 2896707512 |
| Predicate type | https://slsa.dev/provenance/v1 |
| Subject digest | sha512:23b4c7771102918fec6bbaca6e294d20fd45e3834ac381f792a6d283428b52b01a1db50c75771f53c9861463f0e4de5bea63b900c9fc7b0ac9dcafd97 |
Background: How many MCP packages publish verified provenance →
Dependencies 0 packages
| Packages resolved | 0 |
|---|---|
| Tree resolution | Complete |
Background: SBOMs and build attestations, explained →
The tools this component advertises to a client, with an estimated token cost for each. Expand a tool to see its parameters and schema. The per-tool counts are indicative and are not scored directly; the schema's total context footprint is one signal in Schema Quality & AI Usability. A tool's description is untrusted text the model reads on every call, which is what makes this list a security surface and not just an inventory: how tool poisoning works →
auth CloudBase 开发阶段登录与环境 ~678
CloudBase(腾讯云开发)开发阶段登录与环境绑定。登录后即可访问云资源;环境(env)是云函数、数据库、静态托管等资源的隔离单元,绑定环境后其他 MCP 工具才能操作该环境。支持:查询状态、发起登录、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)。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | – | 动作:status=查询状态,start_auth=发起登录,login_by_api_key=API Key登录,set_env=绑定环境(传envId),logout=退出登录 |
| apiKey | string | – | CloudBase API Key,action=login_by_api_key 时必填 |
| apiKeyEnvId | string | – | CloudBase 环境ID(EnvId),action=login_by_api_key 时必填,用于指定 API Key 所属环境 |
| authMode | string | – | 认证模式:device=设备码授权,web=浏览器回调授权 |
| clientId | string | – | 高级可选:自定义 device-code 登录 client_id,不传则使用默认值 |
| confirm | string | – | action=logout 时确认操作,传 yes |
| envId | string | – | 环境ID(CloudBase 环境唯一标识),绑定后工具将操作该环境。action=set_env 时必填 |
| lang | string | – | 输出语言:zh=中文(默认),en=英文。覆盖实例级语言(createCloudBaseMcpServer lang 选项 / TCB_LANG / project.json) |
| oauthCustom | boolean | – | 高级可选:自定义 endpoint 返回格式开关。未配置 endpoint 时默认 false;配置 endpoint 后默认 true。标准 {code,result} 包装格式的端点(如国际站 tcb-api.tencentcloud.com)应显式传 false |
| oauthEndpoint | string | – | 高级可选:自定义 device-code 登录 endpoint。配置后 oauthCustom 默认按 true 处理 |
| region | string | – | 地域(如 ap-shanghai / ap-guangzhou / ap-singapore)。用于 region→site 推断与 API Key 换取网关选择;显式 site 优先 |
| reveal | boolean | – | action=get_temp_credentials 时可选。true=返回明文临时密钥;默认 false 仅返回脱敏结果 |
| site | string | – | 站点:domestic=国内站,intl=国际站。环境开通在腾讯云国际站时,登录(start_auth/login_by_api_key)需显式传 intl,否则会走国内站链路、看不到国际站环境;调用级显式传入优先于 TCB_SITE 环境变量 / region 映射表 / 项目配置,影响登录端点、授权页与 API Key 换取网关 |
No output schema declared.
No examples provided.
callCloudApi 调用云API ~1,038
通用的云 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`。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | 具体 Action 名称,需符合对应服务的官方 API 定义。**不确定时先查官方文档,不要用近义词或历史命名猜测**(猜错会被服务端报成 action invalid,很难排查)。常用 Action 见 skill cloud-api-operations。 |
| params | object | – | Action 对应的参数对象,键名与官方 API 定义一致,不确定时先查文档。**不要把 Region 放这里**,跨地域用顶层 region。CloudBase 业务 API 请优先用 searchKnowledgeBase(mode="openapi"),不要用本工具。示例见 skill cloud-api-operations。 |
| region | string | – | 云 API 地域(X-TC-Region),如 ap-shanghai。跨地域必须传此顶层参数,不要写进 params。⚠️ ap-singapore 同属国内站与国际站,未指定站点按国际站(site=intl)处理:要操作国内站该地域环境,先 auth(action="start_auth", site="domestic") 或设 TCB_SITE=domestic。 |
| service | string | yes | 腾讯云产品标识,**取值只能来自本字段的 enum 白名单(共 57 个)**,决定请求域名 https://<service>.tencentcloudapi.com。名单外的取值一律拒绝,不要臆造;COS 不在云 API 体系内。产品名与 Action 对照见 skill cloud-api-operations。云托管统一走 tcbr。 |
| version | string | – | API 版本(多数场景可省略)。白名单里**只有一个官方版本的产品会自动补齐**,不必传;以下多版本产品必须显式传,缺省会报错并列出可选项:tke、mongodb、teo、monitor、vod、sms。示例:service="tcbr", version="2022-02-17", action="CreateCloudRunEnv", params={EnvId:"env-xxx",Pack… |
No output schema declared.
No examples provided.
deployApply 执行 CloudBase 声明式部署(本地 apply) ~779
解析 cloudbaserc 并按 database→functions→app→hosting→gateway 顺序执行声明式部署。这是 deployPlan 的执行对仗工具(plan 预演 / deployApply 执行同一份 cloudbaserc),属于本地形态的 apply(读本地 cloudbaserc 并在本地构建上传),是会变更云端资源的写操作,必须显式传 confirm=true 才会执行。建议先用 deployPlan 预演,确认计划无误后再执行。 适用边界:本工具用于项目级声明式编排(一份 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 失败仍强制中断)
| Name | Type | Req | Description |
|---|---|---|---|
| concurrency | integer | – | 同类型资源最大并行数,默认 1(串行);仅作用于同类型资源,跨类型依赖顺序不变 |
| confirm | boolean | – | 危险操作确认开关。部署会变更云端资源,必须显式传 confirm=true 才会执行 |
| confirmDestructive | boolean | – | 破坏性数据库变更确认开关。当待执行迁移含 DROP/TRUNCATE/DELETE 或 ALTER…DROP/RENAME 时,必须在 confirm=true 之外额外显式传 confirmDestructive=true;无破坏性迁移时不生效 |
| continueOnError | boolean | – | 某个资源失败后是否继续部署其余资源;database 失败始终强制中断 |
| cwd | string | – | 项目根目录,从此目录向下搜索 cloudbaserc;默认当前工作目录 |
| envId | string | – | 目标环境 ID,优先级高于 cloudbaserc 中的 envId;不传则用配置值或当前绑定环境 |
| mode | string | – | 环境名(如 production/staging),命中 envOverrides.<mode> 时合并覆盖 |
| only | array | – | 仅部署指定资源类型,可选值:database/functions/app/hosting/gateway |
| skip | array | – | 跳过指定资源类型,可选值:database/functions/app/hosting/gateway |
| yes | boolean | – | 遇到已存在资源时是否直接覆盖更新。true=覆盖;false(默认)=保守跳过已存在资源 |
No output schema declared.
No examples provided.
deployBuild 构建声明式配置中的静态托管项目(本地构建) ~288
解析 cloudbaserc 并对 hosting[] 中配置了 buildCommand 的项目执行本地构建(仅执行 buildCommand,不安装依赖、不上传)。对应 CLI 的 tcb app build,但只处理 hosting[] 静态托管项,与 cloudbaserc 的 app 资源类型(云端构建管线)无关。声明式 hosting 部署拆分为「build → plan → apply」三步,本工具是第一步:先本地构建产物,再 deployPlan 预演,最后 deployApply 上传产物。deployApply 不再隐式本地构建 —— 带构建命令的 hosting 项在产物缺失时会报错引导先执行本工具。纯静态托管(未配置 buildCommand 且无法探测框架)自动跳过。构建为纯本地操作:不解析环境、不要求登录,也不需要 confirm。 - cwd:项目根目录,默认当前工作目录 - mode:环境名,命中 envOverrides.<mode> 时合并对应的多环境覆盖配置
| Name | Type | Req | Description |
|---|---|---|---|
| cwd | string | – | 项目根目录,从此目录向下搜索 cloudbaserc;默认当前工作目录 |
| mode | string | – | 环境名(如 production/staging),命中 envOverrides.<mode> 时合并覆盖 |
No output schema declared.
No examples provided.
deployPlan 预演 CloudBase 声明式部署计划 ~513
解析 cloudbaserc 并计算声明式部署计划(dry-run,不产生任何变更)。这是 deployApply 的预演对仗工具:plan 计算、deployApply 执行同一份 cloudbaserc。返回每个资源的动作分类:create=新建,update=覆盖更新,skip=无变更/不会执行,conflict=检测到冲突需中断,deploy=直传覆盖。计划已按 yes 复算为「实际会发生的动作」:不传 yes=true 时,云端已存在的函数会标为 skip(并在 declaredStatus 保留 update),与 deployApply 的实际执行结果一致,避免预演与执行相反。 适用边界:本工具用于项目级声明式编排(一份 cloudbaserc 统一 plan/apply);单资源临时直传请用 manageFunctions/manageHosting/manageApps。 - cwd:项目根目录,默认当前工作目录 - mode:环境名,命中 envOverrides.<mode> 时合并对应的多环境覆盖配置 - envId:目标环境 ID,优先级高于 cloudbaserc 中的 envId;不传则用配置值或当前绑定环境 - only:仅计算指定资源类型的计划 - skip:跳过指定资源类型 - yes:与 deployApply 的 yes 对齐,用于复算已存在函数的有效动作。true=预演为覆盖更新(update);false(默认)=预演为保守跳过(skip)
| Name | Type | Req | Description |
|---|---|---|---|
| cwd | string | – | 项目根目录,从此目录向下搜索 cloudbaserc;默认当前工作目录 |
| envId | string | – | 目标环境 ID,优先级高于 cloudbaserc 中的 envId;不传则用配置值或当前绑定环境 |
| mode | string | – | 环境名(如 production/staging),命中 envOverrides.<mode> 时合并覆盖 |
| only | array | – | 仅计算指定资源类型的计划,可选值:database/functions/app/hosting/gateway |
| skip | array | – | 跳过指定资源类型,可选值:database/functions/app/hosting/gateway |
| yes | boolean | – | 与 deployApply 的 yes 对齐,用于复算已存在函数的有效动作。true=预演为覆盖更新;false(默认)=预演为保守跳过 |
No output schema declared.
No examples provided.
downloadTemplate 下载项目模板 ~492
自动下载并���署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 版本号信息,便于后续维护和版本追踪 - 下载 rules 模板时,如果项目中已存在 README.md 文件,系统会自动保护该文件不被覆盖(除非设置 overwrite=true)
| Name | Type | Req | Description |
|---|---|---|---|
| ide | string | yes | 指定要下载的IDE类型。 |
| overwrite | boolean | – | 是否覆盖已存在的文件,默认为false(不覆盖) |
| template | string | yes | 要下载的模板类型 |
No output schema declared.
No examples provided.
envDomainManagement CloudBase 环境安全域名管理(浏览器 CORS 白名单)【已废弃】 ~431
⚠️ 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 分钟;多数环境数分钟内可收敛。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | 操作类型:create=添加安全域名,delete=删除安全域名 |
| domains | array | yes | 安全域名数组(格式:host:port,例如 localhost:5173 或 127.0.0.1:4173)。注意:不是自定义域名,不需要证书。 |
No output schema declared.
No examples provided.
manageAgents 管理 CloudBase Agent ~135
CloudBase Agent 域统一写入口。支持创建、更新和删除远端 Agent。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | – |
| agentId | string | – | – |
| cosBucketRegion | string | – | – |
| cwd | string | – | – |
| description | string | – | – |
| installDependency | boolean | – | – |
| memorySize | number | – | – |
| name | string | – | – |
| params | object | – | – |
| runtime | string | – | – |
| sessionConfig | object | – | – |
| tempCosObjectName | string | – | – |
| timeout | number | – | – |
| zipFile | string | – | – |
No output schema declared.
No examples provided.
manageAppAuth 管理 CloudBase 应用认证配置 ~585
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,切勿把它当作临时凭证分发。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | – |
| clientId | string | – | updateClientConfig 时的客户端 Id;省略时默认使用当前环境 ID |
| config | object | – | provider / client 的配置对象 |
| displayName | – | – | addProvider 时的展示名称,可传字符串或多语言对象 |
| expireIn | integer | – | createApiKey 时的有效期,单位秒;0 表示不过期。复用已有 key 时该值不生效,此时返回体会带 created=false 与 warnings |
| keyId | string | – | deleteApiKey 时的 API key 唯一标识 |
| keyName | string | – | createApiKey 时的 API key 名称;服务端可能忽略该值(如 publish_key 每环境唯一时),返回体中的 keyName 一律为服务端实际存储的名称 |
| keyType | string | – | createApiKey 时的 API key 类型,默认 publish_key |
| patch | object | – | patchLoginStrategy 使用的简化登录策略 patch,如 { usernamePassword: true } |
| providerId | string | – | provider 标识,如 email、google;addProvider 时也可作为自定义 provider Id |
| providerType | string | – | addProvider 时的 provider 协议类型 |
No output schema declared.
No examples provided.
manageApps 部署应用到 CloudBase(独立子域名) ~1,300
部署 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。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | – |
| appPath | string | – | 应用线上访问路径(hosting mount path),例如 /my-web-app。不是本地目录路径;CloudApp 已有独立子域名,省略时默认为 /(根路径)。 |
| buildCmd | string | – | 构建命令,例如 npm run build。不传时默认 npm run build。本地已构建好可传空字符串 '' 跳过构建步骤。若希望完全跳过远端管道,请改用 manageHosting。 |
| buildPath | string | – | 构建产物目录,相对于 filePath,例如 dist 或 build。 ⚠️ 传此值后远端构建系统会 cd 到此目录再执行 tcb hosting deploy,因此 deployCmd 会自动使用 .(当前目录)而非目录名,避免路径重复(如 dist/dist 错误)。 纯静态 HTML 如果在项目根目录可省略,但注意 deployCmd 默认用 dist。 |
| cosTimestamp | string|number | – | COS 时间戳(getUploadUrl 返回的 unixTimestamp,字符串或数字均可)。传入则直接用已上传的代码创建应用,跳过本地打包上传;需先 getUploadUrl 拿预签名 URL 并 PUT ZIP。cloud mode 必填。与 filePath 严格二选一,同时提供或都不提供都会报错。 |
| deployCmd | string | – | 自定义部署命令。通常无需填写,默认自动生成 tcb hosting deploy 命令。有 buildPath 时远端已 cd 到该目录,默认用 . 作为源码路径;无 buildPath 时默认用 dist。 |
| filePath | string | – | 要上传并部署的本地项目根目录绝对路径。本地模式下 deployApp 时必填;通常传源码所在目录(含 package.json 和源码),不是 dist 目录。构建产物目录请用 buildPath 指定。cloud mode 下无需传此参数,改用 cosTimestamp。 |
| framework | string | – | 前端框架类型。可选值:vue、react、next、nuxt、vite、angular、static。 即使传 static,仍会经过远端构建管道。如果本地已构建好,建议改用 manageHosting 直接上传,可完全跳过远端构建。 |
| ignore | array | – | 上传时忽略的文件/目录 glob 模式,例如 **/node_modules/**。 ⚠️ 打包的是项目根目录(filePath)而非 buildPath 产物目录:若项目根含 target/(Rust)、.next/、dist-old/、build/ 等大构建产物,必须加进 ignore(如 **/target/**),否则整个目录被打进上传 zip(实证 54GB target → 34GB… |
| installCmd | string | – | 依赖安装命令,例如 npm install。不传时默认 npm install。本地已安装或无需安装可传空字符串 '' 跳过,但远端仍会执行 tcb hosting deploy。 |
| nodeJsVersion | string | – | 构建时使用的 Node.js 版本;不传时由 CloudBase 使用默认值。 |
| serviceName | string | yes | CloudBase 应用服务名,会体现在域名中:`<serviceName>-<envId>.webapps.tcloudbase.com`。deployApp 时复用现有 serviceName 会新增一个部署版本并触发重新部署,而不是删除重建。首次部署请用新名称。 |
| versionName | string | – | 要删除的历史版本名,仅 action=deleteAppVersion 时必填。 |
No output schema declared.
No examples provided.
manageCloudRun 管理 CloudRun 服务 ~2,175
管理云托管服务,按开发顺序支持:开通云托管环境(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 开通(异步、幂等)。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | 云托管服务管理操作类型:init=从模板初始化新的云托管项目代码(在targetPath目录下创建以serverName命名的子目录,支持多种语言和框架模板),download=从云端下载现有服务的代码到本地进行开发,run=在本地运行函数型云托管服务(用于开发和调试,仅支持函数型服务),deploy=触发部署并轻量等待任务注册(不会 hang 等完整构建)。源码构建(targetPath)返回… |
| agentConfig | object | – | Agent配置项,仅在createAgent操作时使用 |
| canaryPercent | number | – | 灰度版本流量比例(trafficOp=set 时使用),取值范围0-100。与 stablePercent 之和必须等于100。例如希望 90% 流量打到稳定版、10% 打到灰度版,则 stablePercent=90, canaryPercent=10 |
| envId | string | – | 环境 ID(action=initEnv 时使用;不传则使用当前配置的环境)。格式如 env-xxxxxx |
| envParamsReplaceAll | boolean | – | EnvParams 合并策略(deploy / updateConfig):false(默认)= 与远程按 key 合并(输入覆盖同名 key,远程其余 key 保留);true= 用输入 EnvParams 整包替换远程。仅当显式传入 EnvParams 时生效 |
| force | boolean | – | 强制操作开关,用于跳过确认提示。默认false(需要确认),设置为true时跳过所有确认步骤。删除操作时强烈建议设置为true以避免误操作 |
| imageUrl | string | – | 已有镜像部署(action=deploy 时使用):直接指定容器镜像地址,如 ccr.ccs.tencentyun.com/ns/img:v1 或公网 registry 地址。传入后走 DeployType="image"(容器型)部署,无需本地源码目录(targetPath 可省略)。支持:1) 公网匿名可拉取的镜像直填地址;2) 私有/需登录的镜像(如 ghcr.io)需先在本地 docke… |
| packageType | string | – | 云托管环境套餐类型(action=initEnv 时使用):Trial=试用,Standard=标准,Professional=专业,Enterprise=企业。默认 Trial |
| runOptions | object | – | 本地运行参数配置,仅函数型云托管服务支持。用于配置本地开发环境的运行参数,不影响云端部署 |
| serverConfig | object | – | 服务配置项,用于 deploy / updateConfig。包括资源规格、访问权限、环境变量、日志、网络等。deploy 未提供时对已存在服务仍会从远程合并保留 VpcConf/EnvParams/OpenAccessTypes;updateConfig 至少需要一个配置字段 |
| serverName | string | – | 云托管服务名称,用于标识和管理服务。命名规则:支持大小写字母、数字、连字符和下划线,必须以字母开头,长度3-45个字符。在init操作中会作为在targetPath下创建的子目录名,在其他操作中作为目标服务名。initEnv 操作不需要此参数 |
| serverType | string | – | 服务类型配置:function=函数型云托管(仅支持Node.js,有特殊的开发要求和限制,适合简单的API服务),container=容器型服务(推荐使用,支持任意语言和���架如Java/Go/Python/PHP/.NET等,适合大多数应用场景)。不提供时自动检测:1)现有服务类型 2)有Dockerfile→container 3)有@cloudbase/aiagent-framewor… |
| stablePercent | number | – | 稳定版本流量比例(trafficOp=set 时使用),取值范围0-100。与 canaryPercent 之和必须等于100。例如希望 90% 流量打到稳定版、10% 打到灰度版,则 stablePercent=90, canaryPercent=10 |
| subnetIds | array | – | 子网 ID 列表(action=initEnv 时可选)。当需指定自有 VPC 时必填,如 ["subnet-xxxxxxxx"]。与 vpcId 一起透传给 CreateCloudRunEnv 的 SubNetIds |
| targetPath | string | – | 本地代码路径,必须是绝对路径。在deploy操作中指定要部署的代码目录,在download操作中指定下载目标目录,在init操作中指定云托管服务的上级目录(会在该目录下创建以serverName命名的子目录)。updateConfig 不需要此参数。建议约定:项目根目录下的cloudrun/目录,例如:/Users/username/projects/my-project/cloudrun。使用… |
| template | string | – | 项目模板标识符,用于指定初始化项目时使用的模板。可通过queryCloudRun的templates操作获取可用模板列表。常用模板:helloworld=Hello World示例,nodejs=Node.js项目模板,python=Python项目模板等 |
| trafficOp | string | – | 流量管理子操作(action=traffic 时使用):set=调整灰度流量比例(需先部署新版本至灰度,通过 stablePercent/canaryPercent 设置稳定版与灰度版流量比例,两者之和必须等于100);promote=将灰度版本全量发布(灰度版本流量置为100%并关闭灰度发布,等价于 tcb cloudrun traffic promote);rollback=回滚到上一个稳定… |
| vpcId | string | – | VPC 网络 ID(action=initEnv 时可选)。当平台拒绝系统创建网络时必填,格式如 vpc-xxxxxxxx。与 subnetIds 一起透传给 CreateCloudRunEnv 的 VpcId/SubNetIds。多数场景可不传(由系统创建网络) |
| waitRegistration | boolean | – | deploy 时是否等待平台登记本次发布(默认 true,最多约 45 秒)。等待是为了拿到后续查询所需的标识(源码构建的 BuildId / 镜像部署的 RunId);设为 false 时只做一次探测就返回,响应更快,适合不需要 buildId、之后再按需查询发布任务状态的场景 |
No output schema declared.
No examples provided.
manageDataModel 数据模型管理 ~216
数据模型查询工具,支持查询和列表数据模型(只读操作)。通过 action 参数区分操作类型:list=获取模型列表(不含Schema,可选 names 参数过滤),get=查询单个模型详情(含Schema字段列表、格式、关联关系等,需要提供 name 参数),docs=生成SDK使用文档(需要提供 name 参数)
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | 操作类型:get=查询单个模型(含Schema字段列表、格式、关联关系,需要提供 name 参数),list=获取模型列表(不含Schema,可选 names 参数过滤),docs=生成SDK使用文档(需要提供 name 参数) |
| name | string | – | 要查询的数据模型名称。当 action='get' 或 action='docs' 时,此参数为必填项,必须提供已存在的数据模型名称。可通过 action='list' 操作获取可用的模型名称列表 |
| names | array | – | 模型名称数组(list操作时可选,用于过滤) |
No output schema declared.
No examples provided.
manageEnv CloudBase 环境管理(创建/变配/续费/安全域名) ~998
管理 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)的职责,与本工具无关。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | 操作类型:listPackages=查询可选套餐,create=创建环境,modifyPlan=变更套餐,renew=续费,addSecurityDomain=添加安全域名(CORS 白名单条目),removeSecurityDomain=删除安全域名 |
| alias | string | – | 环境别名(action=create 时必填)。要求:小写字母/数字/减号,不能以减号开头或结尾,最长 20 位 |
| confirm | string | – | 确认操作。所有付费操作(create/modifyPlan/renew)必须传 "yes" 确认 |
| domains | array | – | 安全域名数组(格式:host:port,例如 localhost:5173 或 127.0.0.1:4173)。仅 action=addSecurityDomain/removeSecurityDomain 时有效且必填。注意:这是 CORS 白名单条目,不是自定义域名,不需要证书。添加前应先用 queryEnv(action=domains) 检查浏览器实际 origin 是否已在白名单中。 |
| duration | integer | – | 购买或续费时长(月),action=create/renew 时可选,默认 1 |
| envId | string | – | 环境 ID(action=modifyPlan/renew 时必填) |
| externalStorage | object | – | 云存储共享桶配置(action=create 时可选)。传入该对象表示该环境不再自动分配独立 COS 桶,而是使用指定桶作为云存储介质,通过 basePath 与同桶其他环境隔离;仅作用于云存储,静态托管的存储桶由平台在开通托管时分配。三个字段必须完整传入。⚠️ 与 region 同理:二次调用(confirm="yes")只读本次参数,漏传会创建出使用独立桶的环境且���报错。 |
| packageId | string | – | 套餐 ID(action=create/modifyPlan 时必填)。可选值如 baas_personal(个人版)、baas_pf_standard(标准版)、baas_pf_enterprise(企业版) |
| region | string | – | 创建地域(仅 action=create 时有效)。按 X-TC-Region 语义透传,决定新环境所在地域;等价 CLI:tcb env create --region ap-shanghai。不传则用当前会话地域(cloudBaseOptions.region → TCB_REGION → 项目配置 / rc 绑定 → 站点默认地域:国内站 ap-shanghai、国际站 ap-singap… |
| resources | array | – | 启用的资源类型(action=create 时可选)。可选值:storage(存储)、function(云函数)、postgresql(PostgreSQL),省略时默认全部三项。CreateEnv 要求 Resources 非空,MCP 会始终下发该字段。不再包含 flexdb(文档数据库):新建环境不会创建 NoSQL 实例,其可用性以 queryEnv(action="info") 返回的… |
No output schema declared.
No examples provided.
manageFunctions 管理 CloudBase 云函数 ~1,963
CloudBase 云函数统一写入口。支持创建函数、更新代码、更新配置、调用函数、管理定时跑 / 定时任务 / scheduled job 的 timer 触发器和层绑定。如果要创建 cron 定时任务,先用 createFunction 创建函数,再用 createFunctionTrigger 创建 timer 触发器(支持7段cron表达式),deleteFunctionTrigger 删除触发器。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)
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | 写操作类型,例如 createFunction、updateFunctionCode、incrementalDeployFunction、invokeFunction、deleteFunction、createFunctionTrigger(定时任务 / cron / timer)、deleteFunctionTrigger、createLayerVersion、deleteLayerVersi… |
| autoGrant | boolean | – | 镜像部署是否允许 manager-node 自动补齐固定白名单 CAM 策略。默认 false;仅在明确确认权限变更时设为 true。 |
| base64Content | string | – | 层内容的 base64 编码 |
| codeSecret | string | – | 层绑定时的代码保护密钥 |
| confirm | boolean | – | 危险操作确认开关。deleteFunction、deleteFunctionTrigger、deleteLayerVersion、detachLayer 等删除类操作以及镜像构建部署(func.buildStrategy=cloud/local)真实执行需要显式传入 confirm=true |
| contentPath | string | – | 层内容路径,可为目录或 ZIP 文件 |
| description | string | – | 层版本描述 |
| dryRun | boolean | – | 镜像构建部署(func.buildStrategy=cloud/local)是否只生成部署计划。默认 true;传 false 时必须同时传 confirm=true。 |
| envVariables | object | – | 配置更新时要合并的环境变量。若含 DATABASE_URL / MYSQL_* / POSTGRES_* / REDIS_* 等 TCP 连库变量,必须同时提供真实 vpc(或函数已绑定完整 VPC)。禁止猜测 vpcId/subnetId。 |
| force | boolean | – | createFunction 时是否覆盖 |
| func | object | – | createFunction / updateFunctionCode 的函数配置。镜像/构建部署通过 func.buildStrategy(zip/cloud/local/image)区分,镜像相关字段收敛在 func.imageConfig 命名空间下。 |
| functionName | string | – | 目标函数名称(顶层)。updateFunctionCode / updateFunctionConfig / invokeFunction 等 action 使用此字段。不要只写在 func.name:createFunction 用 func.name,其它 action 用顶层 functionName。若误传 func.name,也会被识别为 functionName。 |
| functionRootPath | string | – | 创建或更新函数代码时默认推荐的本地目录方式。必须是直接包含函数文件夹的目录绝对路径(如 /abs/path/cloudfunctions 或 /abs/path/functions),不要传项目根目录(如 /abs/path),也不要传到函数名子目录(如 /abs/path/cloudfunctions/hello)。本地应按 cloudfunctions/<functionName>/inde… |
| handler | string | – | 函数入口 |
| incrementalFile | string | – | incrementalDeployFunction 增量部署时的变更文件路径 |
| layerName | string | – | 层名称。创建层推荐固定格式 `{layerName}_{当前envId}`(如 common_cloud1-d9ghadgak3edf6b36);不要跨环境复用裸层名。层为账号级共享命名空间 |
| layerVersion | number | – | 层版本号 |
| layers | array | – | updateFunctionLayers 的目标层列表,顺序即最终顺序 |
| licenseInfo | string | – | 层许可证信息 |
| params | object | – | invokeFunction 的调用参数 |
| runtimes | array | – | 层适用的运行时列表 |
| timeout | number | – | 配置更新时的超时时间 |
| triggerName | string | – | deleteFunctionTrigger 的目标触发器名称 |
| triggers | array | – | createFunctionTrigger 的触发器列表,用于定时跑 / 定时任务 / scheduled job。timer 触发器使用7段 cron 表达式(秒 分 时 日 月 星期 年),如 "0 */5 * * * * *" 表示每5分钟执行一次 |
| vpc | – | – | 配置更新时的 VPC 信息。非原生 TCP 连库场景必填真实 vpcId+subnetId;不要用占位符。 |
| wait | boolean | – | 真实镜像部署是否等待完整部署;设为 false 立即返回 taskId 并后台执行。默认 true 是为了兼容既有调用方,但同步等待最长可达约 15 分钟,很容易先撞上 MCP Client 的请求超时——客户端超时只是断开这次请求,云端部署仍在继续,却拿不到 taskId 追踪。因此执行真实构建部署(buildStrategy=cloud/local,dryRun=false)时建议显式传 w… |
| zipFile | string | – | 仅兼容特殊场景:预先准备好的代码包 base64 编码。普通 createFunction/updateFunctionCode 默认不要先压缩 zip,优先使用 functionRootPath。 |
No output schema declared.
No examples provided.
manageGateway 管理 CloudBase 网关 ~1,908
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=静态托管,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 开启)。
| Name | Type | Req | Description |
|---|---|---|---|
| accessType | string | – | 绑定类型(仅 bindCustomDomain,默认 DIRECT)。DIRECT=直连(普通绑域名用这个);CDN=云开发 CDN;CUSTOM=自有 CDN/WAF(需 customCname)。详见 https://docs.cloudbase.net/service/custom-domain |
| action | string | yes | 写操作:createRoute/updateRoute/deleteRoute 管理路由;enableRoute/disableRoute 启用或禁用已有路由(需 path,建议显式传 domain);bindCustomDomain/deleteCustomDomain 管理自定义域名;enableService/authSwitch 开关 HTTP 网关总开关与访问鉴权(需配合 enable… |
| auth | boolean | – | 网关路径鉴权(EnableAuth)。匿名/浏览器公网访问通常 false。只控制网关入口;云函数安全规则、云托管鉴权、静态托管权限需各自工具另行配置。 |
| certificateId | string | – | 证书 ID。仅 bindCustomDomain 使用:显式传入时跳过自动检索;省略时按 domain 调用 describeCertificates(SearchKey=domain)——单证书自动选用,无证书报错,多证书返回结构化选择指引(MCP 非交互)。在已有自定义域名上 createRoute / updateRoute / deleteRoute 不���要 certificateI… |
| customCname | string | – | 自有 CDN/WAF 的回源/回填地址(仅 bindCustomDomain 且 accessType=CUSTOM)。不是 DNS 里用户域名要解析到的那个 CNAME;DIRECT/CDN 不要传。详见 https://docs.cloudbase.net/service/custom-domain |
| domain | string | – | 域名。省略时自动使用环境 DomainType=HTTPSERVICE 的 IsDefault 默认 HTTP 域名(*.{region}.app.tcloudbase.com),不会回退到静态托管 CDN 域名(*.tcloudbaseapp.com,DomainType=STATIC_STORE);也不是 STATIC_STORE 上游绑定。可用 queryGateway(action="l… |
| enable | boolean | – | 开关目标状态:enableService / authSwitch 必填(true 开启 / false 关闭);bindCustomDomain 可选:enable=false 表示绑定后禁用域名(默认启用);updateRoute 可选:映射到 Routes[].Enable(也可用 route.enable,route 优先;也可用专用 action enableRoute/disable… |
| enablePathTransmission | boolean | – | 路径透传(EnablePathTransmission),平台默认 false。例 path=/api 且请求 /api/users:false→上游收到 /users;true→上游收到 /api/users。CBR 云托管(Express 等自管子路由)与 WEB_SCF 多路径函数常需 true;STATIC_STORE 把触发路径映射到站点根目录(如 /app → 托管 /)时通常 fa… |
| path | string | – | 触发路径(网关匹配前缀),默认 /{上游名}。例:云函数 /api/hello、云托管 /api、静态托管 / 或 /app。只建网关入口;与 enablePathTransmission 共同决定上游实际收到的路径。 |
| route | object | – | 路由对象(可选写法)。例:云函数 {upstreamResourceType:"WEB_SCF",serviceName:"fn",path:"/api"};云托管 {upstreamResourceType:"CBR",serviceName:"svc",path:"/api"};静态托管 {upstreamResourceType:"STATIC_STORE",serviceName:"st… |
| targetName | string | – | 上游资源名称(UpstreamResourceName),与 route.serviceName 二选一(route 优先)。云函数=函数名;云托管=服务名;静态托管=实例名(常见 staticstore)。不会自动推断上游类型。 |
| upstreamResourceType | string | – | 上游类型(与 route.upstreamResourceType 二选一,route 优先)。WEB_SCF=HTTP云函数,SCF=Event云函数,CBR=云托管,STATIC_STORE=静态托管,LH=轻量应用服务器。createRoute/updateRoute 必填其一;勿把 manageFunctions 的 type=HTTP|Event 传到本字段。 |
No output schema declared.
No examples provided.
manageHosting 管理 CloudBase 静态托管 ~933
管理 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。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | 管理类型:upload=上传本地构建产物到静态托管,delete=删除静态托管文件或目录,setWebsiteDocument=设置首页/错误页/路由规则,enableService=开通静态托管服务,bindDomain=绑定自定义域名,unbindDomain=解绑自定义域名,updateDomain=更新域名缓存/防盗链/IP 规则,downloadFile=下载单个托管文件到本地,dow… |
| certId | string | – | 证书 ID。仅 action=bindDomain 时必填。 |
| cloudPath | string | – | 静态托管中的目标路径。action=upload 时表示上传后的托管路径;action=delete/downloadFile/downloadDirectory 时表示托管侧文件或目录路径。 |
| confirm | boolean | – | 高风险操作确认开关。action=delete 和 action=unbindDomain 时必须显式传 true,避免误删文件或误解绑域名。 |
| domain | string | – | 自定义域名。action=bindDomain / unbindDomain / updateDomain 时使用,例如 www.example.com。 |
| domainConfig | object | – | 域名配置。仅 action=updateDomain 时必填,支持缓存、Referer、防盗链、IP 规则与频控。 |
| domainId | number | – | 域名 ID。仅 action=updateDomain 时必填,用于精确更新指定域名配置。 |
| errorDocument | string | – | 错误页文档名称。仅 action=setWebsiteDocument 时可选,例如 404.html。 |
| files | array | – | 多文件上传配置。仅 action=upload 时可选;传入后会逐项上传,不再依赖单个 localPath/cloudPath。 |
| ignore | – | – | 上传时忽略的文件模式。仅 action=upload 时可选,例如 node_modules 或 ["**/*.map", "**/.DS_Store"]。 |
| indexDocument | string | – | 网站首页文档名称。仅 action=setWebsiteDocument 时必填,例如 index.html。 |
| isDir | boolean | – | 是否把 cloudPath 视为目录。仅 action=delete 时使用;true=删除目录,false=删除单个文件。 |
| localPath | string | – | 本地路径。action=upload 时表示要上传的本地文件/目录路径;action=downloadFile 或 downloadDirectory 时表示下载到本地的目标路径。建议传绝对路径。 |
| routingRules | array | – | 网站路由规则列表。仅 action=setWebsiteDocument 时可选。SPA 常见配置是将 404 重写到 index.html。 |
No output schema declared.
No examples provided.
manageMysqlDatabase 管理 CloudBase MySQL 数据库生命周期或执行写入 SQL ~301
管理 CloudBase MySQL 数据库资源。支持开通 MySQL、销毁 MySQL、执行写入 SQL/DDL,以及初始化数据库 Schema。注意:必须先开通 MySQL(action=provisionMySQL,confirm=true)才能执行 runStatement 或 initializeSchema。若 MySQL 尚未开通,工具会返回 MYSQL_NOT_CREATED 并给出开通的 nextAction 提示。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | provisionMySQL=创建 MySQL 实例;destroyMySQL=销毁 MySQL 实例;runStatement=执行写入 SQL 或 DDL;initializeSchema=按顺序执行 Schema 初始化语句 |
| confirm | boolean | – | action=provisionMySQL 或 action=destroyMySQL 所需的显式确认 |
| dbInstance | object | – | runStatement/initializeSchema 可选的 SQL 数据库实例上下文 |
| request | object | – | action=provisionMySQL 或 action=destroyMySQL 使用的官方请求载荷 |
| requireReady | boolean | – | initializeSchema 是否应阻塞至确认 MySQL 就绪。默认为 true。 |
| sql | string | – | action=runStatement 使用的 SQL 语句 |
| statements | array | – | action=initializeSchema 使用的有序 Schema 初始化 SQL 语句 |
| statusContext | object | – | initializeSchema 前用于确认就绪状态的可选开通状态请求 |
No output schema declared.
No examples provided.
managePermissions 管理 CloudBase 权限与用户配置 ~1,561
管理 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 的策略)。设置 R…
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | – |
| confirm | boolean | – | 仅 action=setPolicy。设置 Rego 后会立即禁用旧网关鉴权,必须显式传 confirm=true(对齐 CLI 确认提示)。 |
| description | string | – | – |
| memberUids | array | – | – |
| password | string | – | – |
| permission | string | – | – |
| policies | array | – | – |
| policyIds | array | – | 策略 ID 列表(当前不支持直接按 ID 绑定,请改传 policies 详情对象) |
| regoContent | string | – | 仅 action=setPolicy。用户 OPA Rego 全文,必须以 `package authz.user` 开头,对齐 CLI `tcb policy set <regoContent>`。 |
| resourceId | string | – | – |
| resourceType | string | – | 目标资源类型。`securityRule` 的具体语义依赖这个值;`noSqlDatabase` 使用集合安全规则,`function` 与 `storage` 也有各自独立的安全规则语义,不要套用 NoSQL 规则语法。 |
| roleId | string | – | – |
| roleIdentity | string | – | 角色标识符(字母/数字/_-:@.),action=createRole 时必填,用于程序化引用角色 |
| roleIds | array | – | – |
| roleName | string | – | – |
| securityRule | string | – | 资源类型特定的规则内容,详细语义依赖 `resourceType`。当 `resourceType="noSqlDatabase"` 且 `permission="CUSTOM"` 时,应传文档数据库安全规则 JSON(文档型数据库规则:`https://docs.cloudbase.net/database/security-rules`);键通常为 `read` / `create` / `… |
| uid | string | – | – |
| uids | array | – | – |
| userStatus | string | – | – |
| username | string | – | – |
No output schema declared.
No examples provided.
managePgDatabase 管理 PostgreSQL 上下文或执行写入 SQL ~1,516
管理 CloudBase PostgreSQL:执行已确认的写入 SQL、SQL 风险预检、迁移管理。建表/ALTER/DROP 等 schema 变更必须使用 applyMigration(显式 migrationVersion;成功前自动写入或校验本地 cloudbase/migrations/<version>_<name>.sql,与 CLI tcb db pg migration 一致),不要默认用 execute。execute 主要用于 DML 与 GRANT/RLS 等运维 SQL。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | 操作类型:execute=执行已确认的写入 SQL(DML/GRANT/RLS;schema DDL 默认拒绝,需 allowDdlViaExecute=true);dryRun=只分析 SQL 风险不执行;planMigration=预览迁移计划(需 migrationName + migrationVersion + sql;可选 includeAll=true 允许乱序,对齐 CLI --… |
| allowDdlViaExecute | boolean | – | 可选,默认 false。仅当需要故意绕过 migration history 时设为 true,才允许 schema DDL 走 execute;正常建表/改 schema 必须用 applyMigration。 |
| confirm | boolean | – | 执行任何写入 SQL 前都需要显式设置为 true。 |
| defaultSchema | string | – | 可选的默认 schema,默认 public。 |
| envId | string | – | 可选的 CloudBase 环境 ID,不传时使用当前 MCP 环境。 |
| force | boolean | – | fetchMigration 可选,默认 false。true=覆盖本地已存在的同名 SQL 文件(对齐 CLI tcb db pg migration fetch --force);false=跳过已存在文件。用于从远端 history 重新对齐 Git checksum。 |
| includeAll | boolean | – | planMigration / applyMigration 可选,默认 false。true=允许 out-of-order(version 小于远端 LatestVersion)仍可 Preview/Push,对齐 CLI tcb db pg migration up --include-all;仅在确认要补历史/乱序迁移时使用,日常应选更大的 migrationVersion。 |
| instanceId | string | – | 可选的 PostgreSQL 逻辑实例标识,默认 cloudbase-pg。 |
| limit | integer | – | list 可选:返回数量上限,1-500,默认 100。 |
| lockTimeoutMs | integer | – | apply 可选:获取数据库锁的最长时间(毫秒),默认 5000。 |
| migrationName | string | – | plan/apply/repair 必填:migration 名称,小写字母开头,仅允许小写字母和下划线(不允许数字,服务端 PushPGUserMigrations 会拒绝含数字的名称)。 |
| migrationVersion | string | – | 14 位时间戳 YYYYMMDDHHMMSS。plan/apply/detail/repair 必填;fetchMigration 可选(传入则只拉该条,省略���拉全量远端 history);禁止由服务端静默生成,避免与本地 cloudbase/migrations/<version>_<name>.sql 分叉。applyMigration 非增量:每次传完整 SQL;终态失败且 listM… |
| objectName | string | – | 可选的对象名,当前仅用于非 migration 场景。migration 相关操作请使用 migrationName / migrationVersion。 |
| offset | integer | – | list 可选:分页偏移,默认 0。 |
| repairReason | string | – | repair 必填:修复原因。 |
| repairStatus | string | – | repair 必填:applied=标记为已应用(可补录 Query),reverted=删除 history 记录。 |
| role | string | – | 可选的 PostgreSQL role,传给 Manager SDK executePGSql 的 Role(平台会 SET ROLE)。默认 cloudbase_postgres。推荐取值:cloudbase_postgres / anon / authenticated / service_role。不要传 postgres、postgres_pgdb_*、平台保留角色(cloudbase_… |
| rollbackSql | string | – | plan/apply 可选:回滚 SQL 语句。 |
| sql | string | – | action=execute、dryRun、planMigration、applyMigration 或 repairMigration(applied) 使用的 SQL 语句 |
| statementTimeoutMs | integer | – | apply 可选:单条 SQL 执行最长时间(毫秒),默认 300000。 |
| taskId | string | – | describeMigrationTask 必填:PushPGUserMigrations / applyMigration 返回的 TaskId。用于一次性查询 DescribeTaskResult(Status/Phase/Reason),不轮询等待。 |
| taskPollTimeoutMs | integer | – | apply 可选:轮询 DescribeTaskResult 的最长等待(毫秒)。默认 600000(与 CLI tcb db pg migration up 的 10 分钟对齐)。范围 5000-600000。超时后务必先 describeMigrationTask(taskId) 再 listMigrations,禁止立刻重推同 version。 |
| waitForTask | boolean | – | apply 可选,默认 true。设为 false 时 Push 后立即返回 TaskId(errorCode=MIGRATION_TASK_PENDING),由调用方用 describeMigrationTask 轮询任务终态,再用 listMigrations 确认是否落库;适合 MCP host 工具调用超时较短的场景。默认 true 会同步等到任务终态。 |
No output schema declared.
No examples provided.
manageStorage 管理 CloudBase 存储文件 ~638
⚠️ 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,切勿当作默认目标使用。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | 管理操作类型:upload=上传文件或目录,download=下载文件或目录,delete=删除文件或目录 |
| cloudPath | string | yes | 云端文件路径,例如 files/data.txt |
| force | boolean | – | 强制操作开关,删除操作时建议设置为true以确认删除,默认false |
| isDirectory | boolean | – | 是否为目录操作,true=目录操作,false=文件操作,默认false |
| localPath | string | – | 本地文件路径,建议传入绝对路径,例如 /tmp/files/data.txt;upload/download 操作时必填,delete 操作时不需要传该参数 |
No output schema declared.
No examples provided.
modifyDataModel 修改数据模型(当前仅支持创建) ~420
基于Mermaid classDiagram创建数据模型。为保持兼容性,工具名仍为 modifyDataModel;当前仅支持创建新模型,不支持更新现有模型结构。内置异步任务监控,自动轮询直至完成或超时。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | – | 操作类型:create=创建新模型 |
| dbInstanceType | string | – | 数据库实例类型,可选值:MYSQL=MySQL 数据库,FLEXDB=文档型数据库(NoSQL) |
| mermaidDiagram | string | yes | Mermaid classDiagram代码,描述数据模型结构。 示例: classDiagram class Student { name: string <<姓名>> age: number = 18 <<年龄>> gender: x-enum = "男" <<性别>> classId: string <<班级ID>>… |
| publish | boolean | – | 是否立即发布模型 |
No output schema declared.
No examples provided.
queryAgents 查询 CloudBase Agent ~64
CloudBase Agent 域统一只读入口。支持列表、详情与日志查询。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | – |
| agentId | string | – | – |
| pageNumber | number | – | – |
| pageSize | number | – | – |
| params | object | – | – |
No output schema declared.
No examples provided.
queryAppAuth 查询 CloudBase 应用认证配置 ~281
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。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | – |
| clientId | string | – | OAuth client_id / DescribeClient 的 Id;省略时默认使用当前环境 ID(默认客户端) |
| keyType | string | – | API key 类型过滤,可选 publish_key 或 api_key |
| pageNumber | integer | – | API key 列表页码,从 1 开始 |
| pageSize | integer | – | API key 列表每页条数 |
| providerId | string | – | provider 标识,如 email、google |
No output schema declared.
No examples provided.
queryApps 查询 CloudBase 应用部署状态 ~353
查询 CloudBase 应用部署的应用和版本。可查应用列表/详情、版本列表/详情;部署后用 getAppVersion 按 buildId 轮询构建状态;getBuildLog 可查询构建日志用于诊断失败原因。 action=getUploadUrl(只读)可获取预签名上传 URL:无本地文件系统时(cloud mode),先拿到 uploadUrl 自行 PUT 代码 zip,再用返回的 unixTimestamp 调 manageApps(action=deployApp, cosTimestamp) 触发部署。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | – |
| buildId | string|number | – | 构建 ID(数字或数字字符串均可)。getAppVersion 时可与 versionName 二选一;部署返回 BuildId 后可直接用它轮询状态。getBuildLog 时必填。 |
| pageNo | number | – | 分页页码,从 1 开始。 |
| pageSize | number | – | 分页大小。 |
| searchKey | string | – | 按应用服务名模糊搜索关键词,仅 action=listApps 时使用。 |
| serviceName | string | – | CloudBase 应用服务名。getApp / listAppVersions / getAppVersion / getBuildLog / getUploadUrl 时必填;重新部署后复用同一个 serviceName 查询版本历史。 |
| start | number | – | 构建日志偏移量,用于分页拉取后续日志。仅 action=getBuildLog 时使用,不传时从开头返回。 |
| versionName | string | – | 版本名称。getAppVersion 时可与 buildId 二选一;已知版本号时优先传该值。 |
No output schema declared.
No examples provided.
queryCloudRun 查询 CloudRun 服务信息 ~931
查询云托管服务信息,支持获取服务列表、查询服务详情、获取可用模板列表、获取构建日志(getDeployLog,仅云端源码构建/依赖 CODING)、获取运行日志(getProcessLog,镜像与源码部署均可/不依赖 CODING)、获取部署记录以及查询环境云托管开通状态(envStatus)。返回的服务信息包括服务名称、状态、访问类型、配置详情以及最近部署上下文。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | 查询操作类型:list=获取云托管服务列表(支持分页和筛选),detail=查询指定服务的详细信息(包含服务配置和最新部署状态),templates=获取可用的项目模板列表(用于初始化新项目),getDeployLog=获取构建日志(仅云端源码构建有意义,走 CODING/DescribeCloudRunBuildLog;已有镜像部署无构建过程;未登录 CODING 的账号会报错),getPro… |
| buildId | number | – | 构建ID,仅在action=getDeployLog时使用(构建日志,仅云端源码构建)。不传时默认返回最近一次部署的构建日志 |
| detailServerName | string | – | 要查询详细信息、部署记录、构建日志或运行日志的服务名称。当action为detail、getDeployLog、getProcessLog或getDeployRecords时建议提供,必须是已存在的服务名称。可通过list操作获取可用的服务名称列表 |
| envId | string | – | 环境 ID(action=envStatus 时使用;不传则使用当前配置的环境)。格式如 env-xxxxxx |
| pageNum | number | – | 页码,用于分页查询。从1开始,默认值:1。配合pageSize使用可实现分页浏览 |
| pageSize | number | – | 分页大小,控制每页返回的服务数量。取值范围:1-100,默认值:10。建议根据网络性能和显示需求调整 |
| revealEnvParams | boolean | – | 是否返回服务环境变量(ServerConfig.EnvParams)明文值(仅 action=detail 时生效)。默认 false,值脱敏为 "***"(保留 key,足够排查配置了哪些变量、变更是否生效);true 时返回明文,敏感变量(如带密码的 DATABASE_URL)可能暴露给模型上下文,谨慎使用 |
| runId | string | – | 运行ID(RunId),仅在action=getProcessLog时使用。不传时默认取该服务最近一次部署记录的 RunId(与 detail/getDeployRecords 的 latestDeploy.RunId 同源)。镜像部署与源码构建均可查询运行日志 |
| serverName | string | – | 服务名称筛选条件,支持模糊匹配。例如:输入"test"可匹配"test-service"、"my-test-app"等服务名称。留空则查询所有服务 |
| serverType | string | – | 服务类型筛选条件:function=函数型云托管(仅支持Node.js,有特殊的开发要求和限制,适合简单的API服务),container=容器型服务(推荐使用,支持任意语言和框架如Java/Go/Python/PHP/.NET等,适合大多数应用场景) |
No output schema declared.
No examples provided.
queryEnv CloudBase 环境查询 ~2,009
查询 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 还会派生三个用于后端选型的字段: - `EnvInfo.RuntimeMode`:'postgresql' 或 'nosql',表示新业务建议默认使用的后端(PG 已开通时为 postgresql,否则为 nosql)。 - `EnvInfo.RuntimeBackends`:`{postgresql, nosql, mysql}` 三个布尔值,描述当前环境实际并存的后端。 - `EnvInfo.RuntimeModeHints`:每个后端对应的 API/工具/skill 提示。 🌐 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 / `managePermissio…
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | 查询类型:list=环境列表/摘要筛选(按 DescribeEnvs 语义筛选,支持通过 envId / region 筛选,返回 EnvId、Alias、Status、EnvType、Region、PackageId、PackageName、IsDefault,不支持 expiry),info=指定环境的详细信息(必须传入 envId,返回资源字段和计费信息),domains=安全域名列表,u… |
| alias | string | – | 按环境别名筛选。action=list 时可选 |
| aliasExact | boolean | – | 按环境别名精确筛选。action=list 时可选;与 alias 配合使用 |
| endDate | string | – | 用量结束日期(YYYY-MM-DD)。仅 action=usage 时有效;与 startDate 成对传入。不传则使用当前计费周期。 |
| endTime | string | – | 监控结束时间(YYYY-MM-DD HH:mm:ss)。仅 action=metrics 时有效;与 startTime 成对传入。不传则默认最近 24 小时。 |
| envId | string | – | 环境 ID。action=list 时可选(仅按 DescribeEnvs 语义做筛选,仍返回摘要);action=info / action=usage / action=metrics 时必填;action=domains 时可选(不传则查当前绑定环境,传了则查该环境的安全域名)。 |
| fields | array | – | 返回字段白名单。仅支持 EnvId、Alias、Status、EnvType、Region、PackageId、PackageName、IsDefault。action=list 时可选 |
| limit | integer | – | 返回数量上限。action=list 时可选 |
| metricName | string | – | 监控指标名。仅 action=metrics 时有效且必填。GatewayTraceEnvQPS/EnvQPSAll=环境与网关 QPS;FunctionInvocation/FunctionError/FunctionTimeout/FunctionThrottle=云函数调用、错误、超时、限流;DbRead/DbWrite/DbSizepkg=文档库读写与容量;MysqlCpuUsageRa… |
| needUsageDetails | boolean | – | 是否返回每日用量明细。仅 action=usage 时有效;默认 true。 |
| offset | integer | – | 分页偏移。action=list 时可选 |
| period | number | – | 统计周期(秒)。仅 action=metrics 时有效;仅支持 300、3600、86400。不传则由后端按时间范围自动选择。时间范围 ≤1 天不可用 86400;>3 天不可用 300。 |
| region | string | – | 查询地域。仅 action=list 时有效。账号级凭据会把该值透传到 DescribeEnvs(X-TC-Region),例如 ap-singapore。等价 CLI:tcb env list -r <region> --json。环境级凭据(API Key / 托管授权 token)为单环境权限,该参数会被忽略:结果恒为绑定环境,响应的 AppliedFilters.region 为 nul… |
| resourceID | string | – | 资源 ID。仅 action=metrics 时有效。云函数传函数名,文档库传集合名,云托管必须传服务名;GatewayTraceEnvQPS 不传则使用环境级 all|:|all|:|all|:|all。 |
| startDate | string | – | 用量开始日期(YYYY-MM-DD)。仅 action=usage 时有效;与 endDate 成对传入。不传则使用当前计费周期。 |
| startTime | string | – | 监控开始时间(YYYY-MM-DD HH:mm:ss)。仅 action=metrics 时有效;与 endTime 成对传入。不传则默认最近 24 小时。结束时间须晚于开始时间至少五分钟。 |
| subresourceID | string | – | 子资源 ID。仅 action=metrics 时有效;查询云托管某版本监控时传入版本名。 |
| type | array | – | 用量模块过滤。仅 action=usage 时有效;不传则查询全部模块。可选值对齐 tcb CLI:FLEXDB、TDSQL、SCF、EKS、COS、AI、HOSTING、Auth、APIInvocation、HTTPInvocation、VM、Workflow、Other。 |
No output schema declared.
No examples provided.
queryFunctions 查询 CloudBase 云函数 ~1,382
CloudBase 云函数统一只读入口。通过更自解释的 action 查询 CloudBase 云函数列表、函数详情、执行日志、层、触发器和代码下载地址。 **分页说明**:`listFunctions`、`listLayers` 支持 `limit` 和 `offset` 参数。 - `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 触发器配置。 **层(Layer)说明**: - 层为 SCF 账号级共享命名空间:不同环境创建同名层会共享同一层的版本序列;删除某版本会影响所有绑定该版本的环境的函数 - 创建层必须用带环境标识的唯一层名,固定格式:`{layerName}_{当前envId}`(如 `common_cloud1-d9ghadgak3edf6b36`)。不要在不同环境使用相同裸层名,创建前先 `listLayers` 查重 - `listLayers` / `listLayerVersions` / `getLayerVersionDetail` 返回账号级视图,可能含其他环境创建的层 **区分 `queryLogs` 工具**: - 本工具用于查询特定 CloudBase 云函数的执行日志 - `queryLogs` 工具用于搜索 CLS 日志服务(跨服务日志聚合)
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | 只读操作类型: - `listFunctions`: 列出所有 CloudBase 云函数 - `getFunctionDetail`: 获取 CloudBase 云函数详情(需要 functionName) - `listFunctionLogs`: 查询 CloudBase 云函数执行日志(需要 functionName) - `getFunctionLogDetail`: 获取日志详情(需… |
| codeSecret | string | – | 代码保护密钥,用于解密函数代码 |
| endTime | string | – | 日志查询结束时间,格式必须为 YYYY-MM-DD HH:mm:ss(如 2024-01-01 23:59:59)。与 startTime 间隔不能超过一天。不传时默认为当前时间 |
| functionName | string | – | CloudBase 云函数名称。`getFunctionDetail`、`listFunctionLogs`、`listFunctionLayers`、`listFunctionTriggers`、`getFunctionDownloadUrl` 时必填 |
| layerName | string | – | 层名称。`listLayerVersions`、`getLayerVersionDetail` 操作必填。层为账号级共享命名空间;推荐固定格式 `{layerName}_{当前envId}`(如 common_cloud1-d9ghadgak3edf6b36) |
| layerVersion | number | – | 层版本号。`getLayerVersionDetail` 操作必填 |
| limit | number | – | 分页数量(limit)。列表类 action 可选,默认值由后端决定 |
| offset | number | – | 分页偏移(offset)。列表类 action 可选,默认 0 |
| qualifier | string | – | 函数版本别名,如 $LATEST、$DEFAULT。日志查询时可选 |
| requestId | string | – | 日志请求 ID。`getFunctionLogDetail` 操作必填,可从 `listFunctionLogs` 结果中获取 |
| revealEnvValues | boolean | – | getFunctionDetail / listFunctionTriggers 时是否返回环境变量明文值。默认 false:Value 脱敏为 ***,仅保留 Key 与 ValueLength,足以确认配置了哪些变量及变更是否生效;true 时返回明文,敏感变量会进入模型上下文,谨慎使用。如需查看明文,建议优先使用控制台或 CLI |
| runtime | string | – | 层查询的运行时筛选,如 Nodejs18.15 |
| searchKey | string | – | 层名称搜索关键字 |
| startTime | string | – | 日志查询开始时间,格式必须为 YYYY-MM-DD HH:mm:ss(如 2024-01-01 00:00:00)。与 endTime 间隔不能超过一天。不传时默认查询最近一天 |
| taskId | string | – | `getFunctionDeployStatus` 操作时的异步部署任务 ID(由 manageFunctions 的 wait=false 返回)。任务仅保存在当前 MCP 进程内存中:终态任务保留约 30 分钟,运行中任务最长保留 2 小时。 |
No output schema declared.
No examples provided.
queryGateway 查询 CloudBase 网关 ~329
CloudBase HTTP 网关统一只读入口(Domain/Route)。查询域名下路径路由及其上游:WEB_SCF/SCF=云函数,CBR=云托管,STATIC_STORE=静态托管,LH=轻量应用服务器。主键为 Domain + Path;listRoutes / getRoute / listCustomDomains / getPrivilege。getPrivilege 查询 HTTP 网关总开关(enableService)与访问鉴权(enableAuth)状态。实现自定义域名访问前,先 listCustomDomains:若已有自定义域名,优先 createRoute 挂路由(无需证书 ID);仅在没有可用自定义域名时才 bindCustomDomain。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | 只读操作类型:listRoutes、getRoute、listCustomDomains、getPrivilege。getPrivilege 无需其他参数,直接返回 HTTP 网关总开关与访问鉴权状态。自定义域名访问场景先 listCustomDomains 确认是否已有域名可复用。 |
| domain | string | – | 域名。getRoute / listRoutes 过滤时可选 |
| path | string | – | 路由路径。getRoute / listRoutes 过滤时可选 |
| routeId | string | – | 路由 ID。getRoute 时可选 |
| targetName | string | – | 上游资源名过滤(UpstreamResourceName):云函数名、云托管服务名,或静态托管实例名(常见 staticstore)。 |
No output schema declared.
No examples provided.
queryHosting 查询 CloudBase 静态托管 ~303
查询 CloudBase 静态托管的只读信息。适合 AI 先做发现再决定下一步:action=websiteConfig 查询首页/错误页/路由规则与站点域名信息;action=status 查询托管服务状态;action=findFiles 按前缀查找文件;action=listFiles 列出全部托管文件;action=domainStatus 查询自定义域名的当前状态与配置。该工具不会产生任何副作用。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | 查询类型:websiteConfig=查询静态托管网站文档配置与站点域名信息,status=查询静态托管服务状态,findFiles=按前缀查找托管文件,listFiles=列出静态托管中的全部文件,domainStatus=查询自定义域名配置与生效状态。该工具严格只读,不会修改任何资源。 |
| domains | array | – | 要查询的自定义域名列表。仅 action=domainStatus 时使用,例如 ["www.example.com"]。 |
| marker | string | – | 分页起始标记。仅 action=findFiles 时使用,用于续查上一页之后的结果。 |
| maxKeys | integer | – | 单次返回的最大文件条数。仅 action=findFiles 时使用。 |
| prefix | string | – | 文件前缀过滤条件。仅 action=findFiles 时使用,例如 app/ 或 assets/logo。 |
No output schema declared.
No examples provided.
queryLogs 查询 CloudBase 日志服务 ~793
CloudBase 日志域统一只读入口。支持检查日志服务状态并搜索 CLS 日志。 **重要区分**: - 查询云函数日志:使用 `queryFunctions(action="listFunctionLogs", functionName="xxx")` - 查询 CLS 日志(跨服务日志聚合):使用本工具 `queryLogs(action="searchLogs")` **适用场景**: - 检查 CLS 日志服务是否开通:`action="checkLogService"` - 跨服务日志搜索(如搜索所有 ERROR 日志):`action="searchLogs"` - 按 CLS 语法检索特定服务的日志:`action="searchLogs", service="tcb|tcbr"`
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | 操作类型: - `checkLogService`: 检查 CLS 日志服务是否开通 - `searchLogs`: 搜索 CLS 日志(需要提供 queryString) |
| context | string | – | 翻页上下文,用于继续上一次查询 |
| endTime | string | – | 查询结束时间,格式:`YYYY-MM-DD HH:mm:ss`,如 `2024-01-01 23:59:59` |
| limit | number | – | 返回日志条数限制,默认 20 |
| 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"` -… |
| service | string | – | 日志来源服务: - `tcb`: 云函数、数据库、存储等基础服务日志 - `tcbr`: CloudRun 容器服务日志 |
| sort | string | – | 按时间排序:`asc` 升序,`desc` 降序 |
| startTime | string | – | 查询开始时间,格式:`YYYY-MM-DD HH:mm:ss`,如 `2024-01-01 00:00:00` |
No output schema declared.
No examples provided.
queryMysqlDatabase 查询 CloudBase MySQL 数据库状态或执行只读 SQL ~248
查询 CloudBase MySQL 数据库信息。支持执行只读 SQL、查询 MySQL 开通结果、查询 MySQL 任务状态,以及获取当前实例生命周期上下文。标准 getInstanceInfo/describeInstance 不返回连接凭据;仅 getConnectionInfo 透传原始连接/集群载荷(含可能的凭据),且仅用于显式 TCP 迁移。业务 CRUD 优先使用 SDK 或 runQuery/runStatement。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | runQuery=执行只读 SQL;describeCreateResult=查询 CreateMySQL 结果;describeTaskStatus=查询 MySQL 任务状态;getInstanceInfo=获取不含连接凭据的生命周期上下文;describeInstance=getInstanceInfo 的别名;getConnectionInfo=透传可能包含凭据的原始连接/集群载荷(仅限… |
| dbInstance | object | – | runQuery 可选的 SQL 数据库实例上下文 |
| request | object | – | describeCreateResult/describeTaskStatus 使用的官方请求载荷 |
| sql | string | – | action=runQuery 使用的只读 SQL |
No output schema declared.
No examples provided.
queryPermissions 查询 CloudBase 权限与用户配置 ~665
查询 CloudBase 权限与用户配置,支持查询资源权限(数据库/云函数/存储桶等)、角色列表/详情、应用用户列表/详情,以及网关 OPA 授权策略(对齐 CLI `tcb policy list/get`)。 示例: - 查询存储桶权限:`action="getResourcePermission", resourceType="storage", resourceId="bucket-name"` - 列出旧网关策略:`action="listPolicy"`(PG / OPA 引擎环境返回空列表,与 CLI 一致) - 读取用户 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`)或控制台管理权限。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | – |
| extension | boolean | – | 仅 action=getPolicy。true=读取平台为该环境单独配置的策略(authz.platform.extension.rego),默认 false=用户策略(authz.user.rego),对齐 CLI `tcb policy get --extension`。 |
| pageNo | number | – | – |
| pageSize | number | – | – |
| policyResourceType | string | – | 仅 action=listPolicy。按资源类型过滤,当前仅支持 `policy`,对齐 CLI `tcb policy list --resource-type policy`。 |
| resourceId | string | – | – |
| resourceIds | array | – | – |
| resourceType | string | – | – |
| roleId | string | – | – |
| roleIdentity | string | – | – |
| roleName | string | – | – |
| uid | string | – | – |
| username | string | – | – |
No output schema declared.
No examples provided.
queryPgDatabase 查询 PostgreSQL 上下文、对象、元数据或执行只读 SQL ~204
查询 CloudBase PostgreSQL 数据库。支持获取当前 PG 上下文、列出带 schema 的数据库对象、读取轻量元数据、检查单个对象结构,以及执行只读 SQL。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | 操作类型:context=获取当前 PostgreSQL 上下文;objects=列出带 schema 的数据库对象;metadata=获取轻量表元数据;schema=检查单个带 schema 的对象结构;sql=执行只读 SQL |
| limit | integer | – | 可选的摘要数量上限,用于对象、元数据或 SQL 返回行数,默认 20,最大 200。 |
| objectName | string | – | action=schema 时使用的带 schema 的 PostgreSQL 对象名,例如 public.users |
| schema | string | – | 可选的 schema 过滤条件,用于 action=objects 或 action=metadata |
| sql | string | – | action=sql 时使用的只读 SQL |
No output schema declared.
No examples provided.
queryPgStorage 查询 PostgreSQL 环境云存储能力和上传方案 ~228
查询 CloudBase PostgreSQL 环境下的云存储能力。返回 bucket/config 能力摘要、对象信息查询方案,以及基于 HTTP API 或 SDK 的上传实现方案;不会读取本地文件,也不会默认输出大量签名 URL。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | 操作类型:buckets/config=查询存储能力摘要;createBucket=生成 bucket 创建方案(SQL/HTTP API/CLI);uploadPlan=生成 HTTP API/SDK 上传方案;objectInfo=生成对象元信息查询方案;signUpload/signDownload=显式的一次性签名 URL 请求占位 |
| bucket | string | – | 云存储 bucket 名称 |
| expiresIn | integer | – | 签名 URL 有效期,单位秒,范围 60 到 86400。 |
| objectKey | string | – | 单个对象 key |
| objectKeys | array | – | 多个对象 key,用于对象元信息查询规划 |
| objects | array | – | 待上传对象的元信息。文件字节内容不会通过 MCP 传递。 |
No output schema declared.
No examples provided.
queryStorage 查询 CloudBase 存储信息 ~474
⚠️ 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/`。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | 查询操作类型:list=列出目录下的所有文件,info=获取指定文件的详细信息,url=获取文件的临时下载链接,read=读取文本文件内容 |
| cloudPath | string | yes | 云端文件路径,例如 files/data.txt 或 files/(目录) |
| maxAge | number | – | 临时链接有效期,单位为秒,取值范围:1-86400,默认值:3600(1小时) |
No output schema declared.
No examples provided.
readNoSqlDatabaseContent 查询并获取 CloudBase NoSQL 数据库数据记录 ~326
查询 CloudBase NoSQL 数据库中的数据记录。支持按条件筛选、分页、排序,适用于管理端数据查询与运维。limit 默认 100、最大 1000;超出请用 offset 分页。projection 仅支持 { field: 1|0 } 对象(示例 {"_id":1,"name":1,"createdAt":1}),不要传字段数组。
| Name | Type | Req | Description |
|---|---|---|---|
| collectionName | string | yes | 集合名称 |
| instanceId | string | – | 可选:显式指定数据库实例ID;未传时会自动解析并缓存 |
| limit | number | – | 返回数量限制,整数,范围 1-1000,默认 100。超过 1000 会被 Cloud API MgoLimit lte 校验拒绝;请用 offset 分页。 |
| offset | number | – | 跳过的记录数 |
| projection | – | – | 返回字段投影,仅支持对象或对应 JSON 字符串,值只能是 1/0/true/false。合法示例:{"_id":1,"name":1,"createdAt":1}(包含)或 {"password":0}(排除)。不要传 ["name","age"] 这类字段数组,也不要混用包含与排除(_id 除外)。 |
| query | – | – | 查询条件(对象或字符串,推荐对象) |
| sort | – | – | 排序条件,仅支持数组 [{"key":"createdAt","direction":-1}] 或对应 JSON 字符串。 |
No output schema declared.
No examples provided.
readNoSqlDatabaseStructure 读取 CloudBase NoSQL 数据库结构 ~208
读取 CloudBase NoSQL 数据库集合与索引结构,支持列出集合、查看集合详情、列出索引以及检查索引是否存在。本工具为服务端管理工具,用于管理端查询数据库结构,不用于编写客户端代码。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | yes | listCollections: 列出集合列表 describeCollection: 描述集合详情(会返回索引摘要) checkCollection: 检查集合是否存在 listIndexes: 列出指定集合的索引列表 checkIndex: 检查指定索引是否存在 |
| collectionName | string | – | 集合名称(describeCollection、listIndexes、checkIndex 操作时必填) |
| indexName | string | – | 索引名称(checkIndex 操作时必填) |
| limit | number | – | 返回数量限制(listCollections 操作时可选) |
| offset | number | – | 偏移量(listCollections 操作时可选) |
No output schema declared.
No examples provided.
searchKnowledgeBase 云开发知识库检索 ~905
云开发知识库检索工具,支持 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 指南时:searchKnowledgeBase(mode=skill, skillName=auth-tool) - 需要 auth-web 指南时:searchKnowledgeBase(mode=skill, skillName=auth-web) - 需要 cloudbase-agent 指南时:searchKnowledgeBase(mode=skill, skillName=cloudbase-agent) 返回内容包含该 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"。
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | – | 仅 mode=docs 时指定;mode=openapi 不要传 action。CloudBase 文档操作类型:listModules=列出所有文档模块,listModuleDocs=获取指定模块的目录结构,findByName=按名称/路径/URL 智能查找,readDoc=读取指定文档 Markdown,searchDocs=全文搜索官方文档。 |
| apiName | string | – | mode=openapi 时指定。API 名称。 当前暂时无法枚举可选值;如需查看当前可用项,可直接传入字符串,工具会在执行时返回可用列表。 |
| docPath | string | – | mode=docs 且 action=readDoc 时指定。文档相对路径或完整 URL。 |
| input | string | – | mode=docs 且 action=findByName 时指定。支持模块名、文档标题、层级路径或 URL。 |
| mode | string | yes | – |
| moduleName | string | – | mode=docs 且 action=listModuleDocs 时指定。模块名称。 |
| query | string | – | mode=docs 且 action=searchDocs 时指定。全文检索关键词。 |
| skillName | string | – | mode=skill 时指定。技能名称。 当前暂时无法枚举可选值;如需查看当前可用项,可直接传入字符串,工具会在执行时返回可用列表。 |
No output schema declared.
No examples provided.
What is the CloudBase MCP server?
CloudBase is an MCP server listed in the public MCP registry as io.github.TencentCloudBase/cloudbase-mcp. CloudBase MCP: DB, functions, storage, hosting via @cloudbase/cloudbase-mcp. This page covers its npm package (@cloudbase/cloudbase-mcp).
Is the CloudBase MCP server safe to use?
CloudBase scores 88 out of 100 on VerifyMCP. We found no known CVEs affecting it as of 20 September 2026. It declares no install or post-install scripts. Its build provenance is signed and verified. That is a record of what we were able to check automatically, not an endorsement. The category breakdown on this page shows every signal behind the number, including the ones we could not confirm.
What tools does the CloudBase MCP server expose?
CloudBase exposes 40 tools: auth, queryEnv, envDomainManagement, manageEnv, readNoSqlDatabaseStructure, and 35 more. Their descriptions and schemas cost roughly 29,263 tokens of context every time the server is loaded.
Is the CloudBase MCP server still maintained?
CloudBase is still listed as active in the MCP registry. We last reached this channel on 20 September 2026. Those dates come from our own scans of the registry and the channel itself, not from anything the publisher announced.
What licence is the CloudBase MCP server under?
CloudBase declares the MIT licence, which is OSI-approved. That covers the source only, and says nothing about the cost of any service it calls.