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.

• Connect remote by default. Both hosts are first-class endpoints: OAuth covers the login and the hostname decides the site, so there is no site parameter to pass. International: https://tcb-api.tencentcloud.com/mcp/v1; domestic: https://tcb-api.cloud.tencent.com/mcp/v1.
• Use local stdio only when something requires it — an account signing in with a CloudBase API key, one session that must cover both sites (a remote URL is bound to one), or a task that needs a tool the hosted endpoint does not register. Deploying functions or apps is not a reason: that works remotely through the two-step upload. Comparison: references/mcp-setup.md.
• 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.

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). When that fails because git is missing, use the tarball path in references/mcp-setup.md, 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.
• Connecting MCP at all (local stdio versus remote), calling tools from the shell with mcporter, the site / region / plugin switches, or a fix to this open-source repo: read cloudbase-mcp.
• 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-v3" (legacy plan group, only hy3, being retired), "hunyuan-exp" (older legacy builtin), 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 collection APIs or MySQL tools for that path. For Web auth guards, use auth.getSession() and require data.session; do not use deprecated getLoginState() / auth.getUser() as login proof.

High-priority routing

Activation triggers (derived from references/activation-map.yaml)

• Web login / registration / auth UI — CloudBase Web 登录, Web 注册, auth login page, publishable key, 短信登录, 邮箱登录
• WeChat mini program + CloudBase — 小程序 云开发, wx.cloud, mini program cloudbase, OPENID, 小程序数据库
• Native App / Flutter / React Native — Android CloudBase, iOS CloudBase, Flutter CloudBase, React Native CloudBase, 原生 App 接入
• Web projects + NoSQL Database — Web 文档数据库, CloudBase collection, 前端查库, NoSQL Web SDK
• CloudBase PostgreSQL Best Practices — PG access pattern, 数据库访问路径, N+1 查询, 批量查询, 慢查询, EXPLAIN ANALYZE, 缺索引, 活动数据库容量
• CloudBase PostgreSQL / PG — CloudBase PG, PostgreSQL, Postgres, PG 模式, JS SDK v3 PostgreSQL, app.rdb(), queryPgDatabase, managePgDatabase, mysqldb OpenAPI, PostgREST, RLS, service_role, auth schema, storage schema, pgvector, 关系型数据库, 建表
• Existing MySQL (do not recommend) — 已有 MySQL, 现有 MySQL 实例, queryMysqlDatabase, manageMysqlDatabase
• Cloud Functions — 创建云函数, HTTP 云函数, getFunctionLogs, scf_bootstrap, runtime
• CloudRun backend — CloudRun 部署, 云托管, container backend, Dockerfile
• AI Agent (智能体开发) — AI Agent, 智能体, 智能体开发, AG-UI protocol, LangGraph, LangChain, CrewAI, streaming agent, agent UI
• Minimal Web BaaS demo (fast path) — 最小前后端, 最小可用 demo, 最小 fullstack, 搭一套 demo, 带云数据库的 demo, 带云函数+云数据库, 留言板, Todo 应用, todo app, Notes app, Kanban, Lovable, BaaS demo, minimal web baas, 快速 demo
• UI generation — 设计页面, 登录页 UI, frontend interface, 组件样式, prototype
• AI Model (Web) — Web AI 对话, CloudBase AI 流式输出, Web 集成模型
• AI model call (大模型调用 / 文本生成 / 图片生成 / 流式对话) — 大模型调用, AI 模型调用, generateText, streamText, generateImage, 文本生成, 图片生成, 流式对话, hunyuan-exp, deepseek-v4-flash, Token Credits 资源包, 小程序成长计划, ai_miniprogram_inspire_plan, callCloudApi AI 模型, CreateAIModel
• Resource health inspection / troubleshooting — 巡检, 诊断, health check, 资源健康, 异常日志, error inspection, troubleshooting, 错误排查
• Spec workflow / architecture design — 需求文档, 技术方案, tasks.md, Spec 工作流

Routing reminders

• Web auth failures: usually skipped provider config, not missing frontend snippets.
• Native App failures: usually Web SDK paths, not missing HTTP API knowledge.
• Mini program failures: treating wx.cloud like Web auth/SDK.
• New relational databases use PostgreSQL. MySQL skills apply only when the environment already has a MySQL instance.
• CloudBase PG failures: falling back to NoSQL or MySQL, skipping username-password readiness, or guessing raw HTTP instead of app.rdb() / documented OpenAPI.
• AI model failures: usually missing Token Credits / Growth Plan — run DescribeEnvPostpayPackage / DescribeActivityInfo before changing code.

MCP + CLI prerequisite

Prefer CloudBase MCP for management/deploy when tools are loaded in the current session. Setup: references/mcp-setup.md. First-session / unavailable path: references/tooling-fallback.md.

• Preferred install: npx plugins add TencentCloudBase/cloudbase-plugin -y --scope user. Supported --target IDs: claude-code, cursor, codex, grok, kimi, github-copilot, vscode. See references/mcp-setup.md. When plugins add fails with program not found, use the no-git tarball path in that file.
• Verify with npx mcporter list | grep cloudbase or the IDE MCP panel. If npm/npx are missing, see references/tooling-fallback.md (install Node LTS or use IDE marketplace MCP). If MCP is missing or not yet visible after config, still proceed: finish install/config, tell the user a restart unlocks MCP next time, and use tcb CLI now via cloudbase-cli domain skills — do not recommend tcb deploy.
• Prefer device-code login via MCP auth when available; otherwise tcb login. Do not hard-code secrets.

On-demand references

Load only when needed (do not expand this entry):

• references/tooling-fallback.md — MCP vs tcb CLI decision tree for first session / missing tools
• references/site-onboarding.md — first-run site onboarding: trigger/skip, persistence, conflict arbitration, MCP-down fallback
• references/deployment-workflow.md — deploy backend/frontend, manageApps vs hosting, URL/docs updates, optional post-deployment Deployment Share offer (§5)
• references/console-links.md — console hash paths after creating resources
• references/scenarios.md — user-need → CloudBase capability mapping
• references/mcp-setup.md — Plugin install (global default + targets), IDE MCP / mcporter config and auth examples
• references/activation-map.yaml — canonical routing contract source

Reference index

All packaged reference files (required for skill lint reachability):

• activation-map.yaml
• console-links.md
• deployment-workflow.md
• mcp-setup.md
• scenarios.md
• site-onboarding.md
• tooling-fallback.md