cloudbase-declarative-deploy
CloudBase declarative deployment from a cloudbaserc config (声明式部署, 配置式部署, cloudbaserc 部署) through the deployBuild / deployPlan / deployApply MCP tools. Use when deploying database, functions, app, hosting, or gateway resources described in cloudbaserc.json/yaml as a single desired-state config, when a user wants to build static hosting artifacts locally first (deployBuild), or wants a dry-run plan before applying (deployPlan), or when handling multi-environment deploys via mode / envOverrides. Covers build-plan-apply flow (deployBuild local build → deployPlan dry-run → deployApply confirm=true), hosting build-output neutralization, envId resolution priority, only/skip filtering, concurrency, and continueOnError. Prefer deployBuild (when hosting declares a buildCommand) and deployPlan before deployApply; do not confuse with per-resource tcb CLI deploy or single-function deploy.
- License 许可
- MIT
- 最近更新
- 2026-11-11
- Stars
- ★ 447
- Forks
- 138
01 前言 Front Matter
- name
- cloudbase-declarative-deploy
- license
- MIT
- version
- 2.36.2
- alwaysApply
- false
- description
- CloudBase declarative deployment from a cloudbaserc config (声明式部署, 配置式部署, cloudbaserc 部署) through the deployBuild / deployPlan / deployApply MCP tools. Use when deploying database, functions, app, hosting, or gateway resources described in cloudbaserc.json/yaml as a single desired-state config, when a user wants to build static hosting artifacts locally first (deployBuild), or wants a dry-run plan before applying (deployPlan), or when handling multi-environment deploys via mode / envOverrides. Covers build-plan-apply flow (deployBuild local build → deployPlan dry-run → deployApply confirm=true), hosting build-output neutralization, envId resolution priority, only/skip filtering, concurrency, and continueOnError. Prefer deployBuild (when hosting declares a buildCommand) and deployPlan before deployApply; do not confuse with per-resource tcb CLI deploy or single-function deploy.
02 资源文件 3
- 参考文档references/config-schema.md5.4 KB
- 参考文档references/multi-env.md2.0 KB
- 参考文档references/plan-and-apply.md7.4 KB
03 SKILL.md 正文
CloudBase Declarative Deploy
Deploy a whole CloudBase project from one cloudbaserc config as desired state,
using the deployBuild (local hosting build), deployPlan (dry-run) and deployApply
(apply) MCP tools. The orchestrator applies resources in a fixed dependency order:
database → functions → app → hosting → gateway
Sibling skills (local only)
Sibling CloudBase skills ship beside this skill. Use local relative paths such as
../cloudbase-cli/SKILL.md.
Cloud-hosted MCP mode does not guarantee access to a local workspace filesystem or stable relative paths. If a referenced sibling file is not available in cloud mode, use this skill's embedded guidance as source of truth and ask the user for any missing constraints (or to install the missing skill). Do not HTTP-fetch remote skill or protocol markdown into the agent context.
Cross-cutting protocols (required before applying any deploy):
- Change Safety Protocol:
../cloudbase-platform/references/protocols/change-safety-protocol.md - Deployment Gate:
../cloudbase-platform/references/protocols/deployment-gate.md
When to use this skill
- The project has a
cloudbaserc.json/.yaml/.yml/.jsdescribing multiple resources, and the user wants to deploy them together as one config. - The user asks for 声明式部署 / 配置式部署 / "deploy from cloudbaserc" / "deploy the whole project".
- The user wants to preview what a deploy will change before applying (dry-run plan).
- The user wants to build the static hosting artifact locally first (declarative
hosting deploys no longer build implicitly — see
deployBuild). - Multi-environment deploy: production/staging via
mode+envOverrides.
Do NOT use for
- Deploying a single cloud function or one static site via
tcbCLI →../cloudbase-cli/SKILL.md. - In-app SDK integration (web/miniprogram/node) → the matching SDK skill.
- Console UI operations.
Cloud mode: deploy through the two-step upload channel
deployBuild / deployPlan / deployApply in this skill are the local-form declarative
executor. In cloud-hosted MCP mode they are intentionally not registered, because that
runtime has no local cwd and no filesystem-bound execution path.
This is an execution-channel switch, not a capability gap. Everything still deploys, but the artifact is uploaded first and the build runs in the cloud. If those three tools are missing from the tool list, that is expected — pick the channel that matches the resource.
Cloud functions — two-phase zip
queryFunctions(action=getFunctionUploadUrl, functionName?)returnsuploadUrl,uploadHeaders,cosBucketName,cosBucketRegion,cosObjectName,expiresInSecondsPUTthe function zip touploadUrlwithuploadHeadersmanageFunctions(action=createFunction|updateFunctionCode, code={cosBucketName, cosObjectName, cosBucketRegion?})— phase B deploys from the environment's own COS bucket (deployMode=cos); pass the triple through unchanged, the schema is strict
contentPath (a local directory) is rejected in cloud mode. For layer contents use
base64Content; for code use the two-phase path above.
CloudApp — two-step upload plus a cloud pipeline
queryApps(action=getUploadUrl, serviceName=...)returnsuploadUrl,uploadHeaders,unixTimestamp- Upload the source/build zip to
uploadUrlwith the returned headers (Content-Type: application/zip)- Public dependencies resolvable from a lockfile:
package.jsonplus lockfile is enough - Private or offline dependencies: package
node_modulesexplicitly
- Public dependencies resolvable from a lockfile:
manageApps(action=deployApp, cosTimestamp=<unixTimestamp>, installCmd?, buildCmd?, deployCmd?)installCmd/buildCmd/deployCmdare pipeline declarations executed in the cloud container; you pass data and declarations, you do not run local shell commands
Static hosting — route through CloudApp
manageHosting(action=upload) is blocked in cloud mode because it needs a local path.
Deploy a static site through the CloudApp two-step upload above (upload the prebuilt
artifact, exclude node_modules). Uploading or downloading an already-hosted file has no
remote substitute and needs local mode. The other hosting actions (delete,
setWebsiteDocument, enableService, bindDomain, unbindDomain, updateDomain) remain
available.
What cloud mode does not give you
- No dry-run. There is no
deployPlanagainst a localcloudbaserc. Do not claim a plan was generated or reviewed in cloud mode; state what is about to be deployed and what the upload contains. Roadmap: uploadcloudbasercas a data artifact, then run server-side plan/apply orchestration. - No local project context.
mode/envOverridesresolution from a project file does not apply; pass the target environment explicitly.
For parameter details, see references/plan-and-apply.md (Cloud-hosted upload pipeline path).
Core principles
-
Plan before apply — always. Run
deployPlanfirst (dry-run, zero side effects). Read the per-resource action classification and show it to the user before callingdeployApply. -
Apply requires explicit confirm.
deployApplywill refuse unlessconfirm=trueis passed. This is the destructive-write guard. -
Deployment Gate. Before any apply, complete
cloudbase-platform/references/protocols/deployment-gate.mdand present the mandatory declaration. -
Conservative on existing resources by default.
yesdefaults tofalse→ existing resources are skipped, not overwritten. Only passyes=truewhen the user explicitly wants to overwrite/update existing resources. -
database failure always aborts. Even with
continueOnError=true, a database-stage failure stops the whole deploy, because later resources depend on it. -
Resolve envId explicitly. Never rely on implicit defaults silently — know which environment is targeted (see the priority table below) and confirm it with the user before applying.
Plan action classification
deployPlan returns a list of resource entries. Each status means:
| status | meaning |
|---|---|
create |
new resource, will be created |
update |
exists, will be overwritten/updated |
skip |
no change needed |
conflict |
conflict detected — deploy will abort, must resolve first |
deploy |
direct overwrite upload |
If any entry is conflict, stop and resolve it before applying.
envId resolution priority
explicit envId param > cloudbaserc `envId` > logged-in / bound environment
If none can be resolved, the tool errors out. Prefer confirming the resolved envId with the user before applying to production.
Local workflow (build → plan → apply)
When hosting declares a buildCommand, declarative deploy is a three-step flow —
deployApply no longer runs the local build implicitly:
- Ensure a
cloudbasercconfig exists under the project root (cwd). - Build first (only when
hostinghas abuildCommand): calldeployBuild({ cwd, mode? })to produce the local artifacts (builds every hosting item; pure-static items without a build command are skipped automatically).- If the build artifacts are missing at apply time,
deployApplyfails withBUILD_OUTPUT_NOT_FOUNDand directs you back to this step — calldeployBuildfirst, then retry. deployBuildneeds noenvIdand noconfirm(local build only, never touches cloud resources); if dependencies are not installed it fails withDEPENDENCY_NOT_INSTALLEDand tells you to run install first.
- If the build artifacts are missing at apply time,
- Call
deployPlan(optionally withmode,envId,only,skip). Read the plan. - Present the plan + Deployment Gate declaration to the user; get confirmation.
- Call
deployApplywithconfirm=true(plusyes/concurrency/continueOnErroras needed). Reuse the samemode/envId/only/skipas the plan. A hosting item with existing build output is uploaded directly (the tool clears the build command and reportshostingNeutralized: true); rebuild withdeployBuildafter source changes so the upload is not stale. - Report the applied result back to the user.
For cloud-hosted MCP mode, do not ask for local cwd/filesystem reads; use the
Cloud mode upload-channel flow above.
Build & pipeline execution
Use this mental model: build → plan → apply. The build executor depends on resource type.
| resource | typical build executor | deployment path |
|---|---|---|
hosting |
deployBuild (local shell build, run before apply) |
deployApply uploads the built output directly; missing output → BUILD_OUTPUT_NOT_FOUND |
app (framework=static) |
local prebuilt artifact | package upload + deploy record |
app (non-static frameworks) |
cloud pipeline | source zip upload + cloud build + deploy |
functions |
local zip / cloud build / image pipeline | depends on buildStrategy (zip/cloud/local/image) |
deployBuild builds every hosting item that has a buildCommand (framework mapping or
package.json auto-detection); it skips pure-static items. Build failures surface as
BUILD_FAILED, missing local dependencies as DEPENDENCY_NOT_INSTALLED (run install
first — deployBuild never installs dependencies for you).
Build command resolution follows declaration priority:
explicit config > framework mapping defaults > package.json auto-detection
buildCommand / installCommand / deployCmd are declarative intent in config.
Execution ownership depends on path:
- local-form paths: specific steps may run in local shell executor
- cloud-hosted paths: commands are executed by cloud pipeline container (staticCmd), or replaced by prebuilt artifact upload
So the answer to "can cloud mode run local CLI commands" is: execution authority is moved from local shell to cloud pipeline; agent transmits declarations and artifacts.
Routing
| User task | Read |
|---|---|
| cloudbaserc resource fields & desired-state config shape | references/config-schema.md |
| deployPlan → deployApply two-step flow, parameters, safety | references/plan-and-apply.md |
| Multi-env (mode / envOverrides), envId priority, env vars | references/multi-env.md |
Minimum self-check
- [ ] Built the hosting artifacts first (
deployBuild) whenhostingdeclares abuildCommand? - [ ] Ran
deployPlanand read the action classification beforedeployApply? - [ ] Resolved and confirmed the target
envId? - [ ] Completed the Deployment Gate declaration before applying?
- [ ] Passed
confirm=trueonly after user confirmation? - [ ] Left
yes=falseunless overwrite of existing resources was explicitly requested? - [ ] Handled any
conflictentries before applying?
Reference index
All packaged reference files (required for skill lint reachability):
04 同仓库更多 Skills
yingmi-skill
当用户需要查询基金、策略、公告、财经资讯,做资产配置、组合诊断、风险回测、现金流分析,或生成图表、PDF 时,优先使用本 Skill 获取真实数据与可执行能力。
web-access
所有联网操作必须通过此 skill 处理,包括:搜索、网页抓取、登录后操作、网络交互等。
tencentmap-map-assistant
腾讯位置服务·地图助手 Skill,一句自然语言调用腾讯地图全套能力,无需开发者账号、开箱即用。提供 AI 旅游攻略、地点搜索(含评分/人均/营业时间)、关键词提示、路线规划(驾车/步行/公交/骑行)、地址解析与逆解析、行政区划、IP 定位、距离计算、天气查询,并可将行程或多 POI 渲染成网页地图。涉及找地点、规划路线、旅游行程、查天气、坐标转换等出行场景时使用。
skill-scanner
Scan any agent skill for security risks before you install or use it. Powered by Tencent Zhuque Lab A.I.G (AI-Infra-Guard). 100% local static analysis — no file contents or credentials leave your device. Compatible with CodeBuddy, Cursor, Windsurf, Claude Code, OpenClaw and more. Triggers on: 这个 skill 安全吗, skill 安全扫描, 检查 skill 安全, audit skill, scan skill, check skill safety, analyze skill, inspect skill, verify skill, skill security, skill supply chain. Do NOT trigger for general agent usage, full system health checks, project debugging, or normal development.
skill-creator
Guide for creating effective skills. This skill should be used when users want to create a new skill (or update an existing skill) that extends agent capabilities with specialized knowledge, workflows, or tool integrations.
shader-dev
Comprehensive GLSL shader techniques for creating stunning visual effects — ray marching, SDF modeling, fluid simulation, particle systems, procedural generation, lighting, post-processing, and more.