Cloudbase

CloudBase Development Guidelines

📁 Reference Files Location

All reference documentation files are located in the references/ directory relative to this file.

File Structure:

cloudbase/
├── SKILL.md              # This file (main entry)
└── references/           # All reference documentation
    ├── auth-web-cloudbase/SKILL.md              # Web authentication guide
    ├── auth-wechat-miniprogram/SKILL.md         # WeChat authentication guide
    ├── cloudbase-document-database-web-sdk/SKILL.md # NoSQL database for Web
    ├── ui-design/        # UI design guidelines
    └── ...               # Other reference docs

How to use: When this document mentions reading a reference file like references/auth-web-cloudbase/SKILL.md, simply read that file from the references/ subdirectory.

Step 0 — Confirm the site (domestic vs international)

CloudBase has two independent account systems: 国内站 (domestic, cloud.tencent.com) and 国际站 (international, tencentcloud.com). Environments, consoles, API keys, and login state do not cross over. A wrong-site login usually looks like "logged in, but no environments visible" rather than a clear error — so settle the site before installing MCP, logging in, or binding an env.

Infer it when you can (console domain, envId, an existing error); otherwise ask the user once. Do not guess.

• International users: connect the international remote MCP endpoint directly — https://tcb-api.tencentcloud.com/mcp/v1. It is a first-class hosted endpoint; OAuth covers the login. The site is decided by the host, so there is no site query parameter to pass.
• Domestic remote MCP is the same shape at https://tcb-api.cloud.tencent.com/mcp/v1 — that stays the default for domestic users.
• TCB_IS_INTL (CLI) and TCB_SITE (MCP) are different variable names for different tools. Set the one matching the tool in use; setting the wrong one silently does nothing.
• On a first run, settle the site once and persist it — the CLI switch is machine-global, the MCP switch is per-client, and only .cloudbase/project.json is project-scoped and readable by MCP after a restart. Follow references/site-onboarding.md; do not re-ask on later sessions.

Details and copy-paste configs: references/mcp-setup.md. CLI specifics: references/tooling-fallback.md. First-run orchestration (trigger/skip, conflict arbitration, MCP-down fallback): references/site-onboarding.md.

International site (intl) — read first

This connector is bound to the CloudBase international site, whose accounts, environments, and billing are separate from the China site. Before acting, read references/international-site.md for the international console and gateway hosts, the region to use, OAuth sign-in behaviour, and the capabilities that this site does not have.

Workflow

1. Exploration  →  Read the matching skill completely before writing any code.
                   Search with searchKnowledgeBase(mode="skill"), then Read full SKILL.md.
2. Implementation
   ├── 2a. Resource preparation → Prefer MCP; if MCP tools are missing in THIS session,
   │     configure MCP for next session and use `tcb` CLI now (see tooling-fallback.md)
   └── 2b. Frontend implementation → Write code, install deps, start server, test
3. Close-out  →  Run cloudbase-code-review, fix errors, declare done
                   (after a verified deploy: optionally offer Deployment Share once — see references/deployment-workflow.md §5)

Key constraints: Stage 2a must precede frontend code. Stage 3 is mandatory.

Activation Contract

Routing uses stable skill ids (auth-tool-cloudbase, auth-web-cloudbase, http-api-cloudbase, …) across source, generated artifacts, and installs.

Standalone skill fallback

If only one published skill is exposed:

• Prefer local relative paths (references/<skill-id>/SKILL.md or sibling skill directories) when those files exist in the workspace.
• Do not fetch sibling skill markdown from remote raw URLs into the agent context.
• If a required sibling skill is missing locally, ask the user to install the full CloudBase skills pack or IDE plugin (npx skills add tencentcloudbase/cloudbase-skills), then continue using local files only.

Follow relative references/... paths from the current skill. If MCP is unavailable in this session, follow references/tooling-fallback.md: configure MCP via references/mcp-setup.md for the next session, and use tcb CLI via the references/cloudbase-cli/SKILL.md skill (read core.md + the matching domain reference — not tcb deploy) to finish login/manage now. If npm/npx are missing, follow the “No npm/npx” section in tooling-fallback.md.

Global rules before action

• Identify the scenario, then read the matching skill before writing code or calling CloudBase APIs.
• Prefer semantic sources for toolkit maintenance; express runtime routing in stable skill ids.
• Prefer MCP or mcporter for management tasks when those tools are available in this session; inspect tool schemas before execution. If they are not available yet, do not stall — use the CLI fallback in references/tooling-fallback.md.
• UI tasks: read ui-design first and output the design spec before interface code.
• Auth tasks: read auth-tool-cloudbase first and enable providers before frontend implementation.
• Keep auth domains separate: management login uses auth (or tcb login when MCP auth is unavailable); app-side auth uses queryAppAuth / manageAppAuth.

Universal guardrails

• After 2–3 failed attempts on the same path, stop and reroute (platform skill, runtime, auth domain, permission model, SDK boundary).
• Always specify EnvId explicitly; do not rely on CLI-selected or implicit env state.
• When the environment identifier is an alias, nickname, or other short form, do not pass it directly to auth.set_env, SDK init, console URLs, or generated config. First resolve it to the canonical full EnvId with queryEnv(action=list, alias=..., aliasExact=true). If multiple environments match or no exact alias exists, stop and clarify with the user.
• When writing MCP/tool results to a file, pass serialized text (JSON.stringify(result, null, 2)), not raw objects. If a write tool says content expected a string but received an object, do not retry with the same raw object. Serialize the object first, then retry once with the serialized text, and make sure the retried call actually passes the serialized string rather than the original object.
• Keep scenario-specific pitfalls in child skills — do not expand this entry file.
• First frontend deploy must use manageApps(action="deployApp", ...). There is no createApp / updateApp action — first deploy and re-deploy both use deployApp, and a re-deploy reuses the same serviceName. manageHosting is only for incremental updates of projects originally deployed via hosting.

Engineering constitution (applies to every scenario)

These rules override convenience. Full rationale lives in web-development.

• Prepare backend resources before writing frontend code. Prefer MCP for auth providers, tables, storage domains, and security rules; if MCP tools are missing in this session, use tcb CLI after configuring MCP for the next session (references/tooling-fallback.md).
• Do NOT use any to bypass type errors. Prefer unknown + type guards / precise interfaces.
• Self-verify before claiming done. Static (tsc / lint / build / tests) and runtime (agent-browser for user-visible flows). Name gaps explicitly if a layer cannot run.
• Do not paper over failures. No empty try/catch, no deleting failing tests to go green.
• ai.createModel(...) / wx.cloud.extend.AI.createModel(provider) takes a GroupName, not a vendor/model id. Legal: "cloudbase", "hunyuan-exp", or "custom-<name>". Model ids go in generateText / streamText model field. See ai-model-web / ai-model-nodejs / ai-model-wechat.
• Low-capability STOP card: For PostgreSQL / CloudBase PG / app.rdb() / queryPgDatabase / managePgDatabase, route to postgresql-development-cloudbase — do not use NoSQL/manageMysqlDatabase for that path. For Web auth guards, use auth.getSession() and require data.session; do not use deprecated getLoginState() / auth.getUser() as login proof.