📁 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 site (domestic, cloud.tencent.com) and International site (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.
| Domestic site domestic | International site international | |
|---|---|---|
| Remote MCP (preferred) | https://tcb-api.cloud.tencent.com/mcp/v1 |
https://tcb-api.tencentcloud.com/mcp/v1 |
| Local stdio MCP | default — nothing to set | TCB_SITE=intl + TCB_REGION=ap-singapore |
tcb CLI |
default | TCB_IS_INTL=true (or tcb config set isIntl true) |
Project record .cloudbase/project.json |
site omitted, or "domestic" |
"site": "intl", "region": "ap-singapore" |
| Console | tcb.cloud.tencent.com |
tcb.tencentcloud.com |
| Default region | ap-shanghai |
ap-singapore |
| NoSQL / document DB tools | available | not available |
- 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 nositequery 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) andTCB_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.jsonis project-scoped and readable by MCP after a restart. Followreferences/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.mdor 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. - 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-designfirst and output the design spec before interface code. - Auth tasks: read
auth-tool-cloudbasefirst and enable providers before frontend implementation. - Keep auth domains separate: management login uses
auth(ortcb loginwhen MCP auth is unavailable); app-side auth usesqueryAppAuth/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
EnvIdexplicitly; 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 fullEnvIdwithqueryEnv(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 sayscontentexpected 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 nocreateApp/updateAppaction — first deploy and re-deploy both usedeployApp, and a re-deploy reuses the sameserviceName.manageHostingis 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
tcbCLI after configuring MCP for the next session (references/tooling-fallback.md). - Do NOT use
anyto bypass type errors. Preferunknown+ type guards / precise interfaces. - Self-verify before claiming done. Static (
tsc/ lint / build / tests) and runtime (agent-browserfor 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 ingenerateText/streamTextmodelfield. Seeai-model-web/ai-model-nodejs/ai-model-wechat.- Low-capability STOP card: For PostgreSQL / CloudBase PG /
app.rdb()/queryPgDatabase/managePgDatabase, route topostgresql-development-cloudbase— do not use NoSQL/manageMysqlDatabasefor that path. For Web auth guards, useauth.getSession()and requiredata.session; do not use deprecatedgetLoginState()/auth.getUser()as login proof.
High-priority routing
| Scenario | Read first | Then read | Do NOT route to first | Must check before action |
|---|---|---|---|---|
| Web login / registration / auth UI | auth-tool-cloudbase |
auth-web-cloudbase, web-development |
cloud-functions, http-api-cloudbase |
Provider status and publishable key |
| WeChat mini program + CloudBase | miniprogram-development |
auth-wechat-miniprogram, cloudbase-document-database-in-wechat-miniprogram |
auth-web-cloudbase, web-development |
Whether the project really uses CloudBase / wx.cloud |
| Native App / Flutter / React Native | http-api-cloudbase |
auth-tool-cloudbase, relational-database-mcp-cloudbase |
auth-web-cloudbase, cloudbase-document-database-web-sdk, web-development |
SDK boundary, OpenAPI, auth method |
| Web projects + NoSQL Database | web-development |
cloudbase-document-database-web-sdk, auth-web-cloudbase |
relational-database-mcp-cloudbase, http-api-cloudbase |
Login state and database access permission model |
| CloudBase PostgreSQL Best Practices | postgresql-best-practices-cloudbase |
postgresql-development-cloudbase |
cloudbase-document-database-web-sdk |
Access paths, index decisions, row authorization, and launch capacity |
| CloudBase PostgreSQL / PG | postgresql-development-cloudbase |
auth-tool-cloudbase, auth-web-cloudbase, web-development, miniprogram-development, cloud-storage-web, http-api-cloudbase |
relational-database-mcp-cloudbase, cloudbase-document-database-web-sdk |
PG schema, usernamePassword login, backend/RLS permission model |
| MySQL Database (relational) | relational-database-mcp-cloudbase |
relational-database-web-cloudbase, http-api-cloudbase |
cloudbase-document-database-web-sdk, web-development |
Distinguish MCP management vs app code access |
| Cloud Functions | cloud-functions |
auth-tool-cloudbase, ai-model-nodejs |
cloudrun-development, auth-web-cloudbase |
Event vs HTTP function, runtime, scf_bootstrap |
| CloudRun backend | cloudrun-development |
auth-tool-cloudbase, relational-database-mcp-cloudbase |
cloud-functions |
Container boundary, Dockerfile, CORS |
| AI Agent (intelligent agent development) | cloudbase-agent |
cloud-functions, cloudrun-development |
cloud-functions, cloudrun-development |
AG-UI protocol, scf_bootstrap, SSE streaming |
| Minimal Web BaaS demo (fast path) | minimal-web-baas-demo |
web-development, cloudbase-document-database-web-sdk, postgresql-development-cloudbase |
cloud-functions, cloudrun-development, spec-workflow, ui-design |
BaaS-first Web SDK CRUD, MCP schema only, zero cloud functions unless secrets/cron/rules-cannot-express |
| UI generation | ui-design |
web-development, miniprogram-development |
cloud-functions |
Design specification first |
| AI Model (Web) | web-development |
ai-model-web, ui-design |
ai-model-wechat, http-api-cloudbase |
Platform and streaming interaction mode |
| AI model call (large model call / text generation / image generation / streaming conversation) | ai-model-web |
ai-model-nodejs, ai-model-wechat |
cloudbase-agent, cloud-functions, cloudrun-development |
First run the "required qualification check before calling":DescribeActivityInfo(Mini Program Growth Plan) + DescribeEnvPostpayPackage(Token Credits resource package) |
| Resource health inspection / troubleshooting | ops-inspector |
cloud-functions, cloudrun-development |
ui-design, spec-workflow |
CLS enabled, time range for logs |
| Spec workflow / architecture design | spec-workflow |
cloudbase |
web-development, cloud-functions |
Requirements, design, tasks confirmed |
Activation triggers (derived from references/activation-map.yaml)
- Web login / registration / auth UI — CloudBase Web login, Web registration, auth login page, publishable key, SMS login, email login
- WeChat mini program + CloudBase — Mini Program Cloud Development, wx.cloud, mini program cloudbase, OPENID, Mini Program database
- Native App / Flutter / React Native — Android CloudBase, iOS CloudBase, Flutter CloudBase, React Native CloudBase, native App integration
- Web projects + NoSQL Database — Web document database, CloudBase collection, frontend database query, NoSQL Web SDK
- CloudBase PostgreSQL Best Practices — PG access pattern, database access path, N+1 query, batch query, slow query, EXPLAIN ANALYZE, missing index, active database capacity
- CloudBase PostgreSQL / PG — CloudBase PG, PostgreSQL, Postgres, PG mode, JS SDK v3 PostgreSQL, app.rdb(), queryPgDatabase, managePgDatabase, mysqldb OpenAPI, PostgREST, RLS, service_role, auth schema, storage schema, pgvector
- MySQL Database (relational) — MySQL table creation, executeWriteSQL, security rule, CloudBase relational database management
- Cloud Functions — Create cloud function, HTTP cloud function, getFunctionLogs, scf_bootstrap, runtime
- CloudRun backend — CloudRun deployment, Cloud Hosting, container backend, Dockerfile
- AI Agent (intelligent agent development) — AI Agent, intelligent agent, intelligent agent development, AG-UI protocol, LangGraph, LangChain, CrewAI, streaming agent, agent UI
- Minimal Web BaaS demo (fast path) — Minimal frontend and backend, minimal viable demo, minimal fullstack, build a demo, demo with cloud database, with cloud function + cloud database, message board, Todo app, todo app, Notes app, Kanban, Lovable, BaaS demo, minimal web baas, quick demo
- UI generation — Design page, login page UI, frontend interface, component styles, prototype
- AI Model (Web) — Web AI conversation, CloudBase AI streaming output, Web integrated model
- AI model call (large model call / text generation / image generation / streaming conversation) — Large model call, AI model call, generateText, streamText, generateImage, text generation, image generation, streaming conversation, hunyuan-exp, deepseek-v4-flash, Token Credits resource package, Mini Program Growth Plan, ai_miniprogram_inspire_plan, callCloudApi AI model, CreateAIModel
- Resource health inspection / troubleshooting — Inspection, diagnosis, health check, resource health, abnormal logs, error inspection, troubleshooting, error troubleshooting
- Spec workflow / architecture design — Requirements document, technical solution, tasks.md, Spec workflow
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.cloudlike Web auth/SDK. - CloudBase PG failures: falling back to MySQL/NoSQL, 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/DescribeActivityInfobefore 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--targetIDs:claude-code,cursor,codex,grok,kimi,github-copilot,vscode. Seereferences/mcp-setup.md. - Verify with
npx mcporter list | grep cloudbaseor the IDE MCP panel. Ifnpm/npxare missing, seereferences/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 usetcbCLI now viacloudbase-clidomain skills — do not recommendtcb deploy. - Prefer device-code login via MCP
authwhen available; otherwisetcb login. Do not hard-code secrets.
On-demand references
Load only when needed (do not expand this entry):
references/tooling-fallback.md— MCP vstcbCLI decision tree for first session / missing toolsreferences/site-onboarding.md— first-run site onboarding: trigger/skip, persistence, conflict arbitration, MCP-down fallbackreferences/deployment-workflow.md— deploy backend/frontend,manageAppsvs hosting, URL/docs updates, optional post-deployment Deployment Share offer (§5)references/console-links.md— console hash paths after creating resourcesreferences/scenarios.md— user-need → CloudBase capability mappingreferences/mcp-setup.md— Plugin install (global default + targets), IDE MCP / mcporter config and auth examplesreferences/activation-map.yaml— canonical routing contract source
Reference index
All packaged reference files (required for skill lint reachability):