CtrlK
BlogDocsLog inGet started
Tessl Logo

cloudbase

Essential CloudBase (TCB, Tencent CloudBase, 云开发, 微信云开发) development guidelines. MUST read for CloudBase Web apps, mini programs, backend services, cloud functions, MySQL/NoSQL/PostgreSQL, auth, storage, CloudRun, or AI/LLM work. Do NOT use for non-Tencent-Cloud / non-CloudBase projects, pure frontend with no CloudBase backend, or self-hosted backends with no CloudBase dependency.

SKILL.md
Quality
Evals
Security

CloudBase Development Guidelines

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 → MCP tools first (auth, DB, storage, security rules)
   └── 2b. Frontend implementation → Write code, install deps, start server, test
3. Close-out  →  Run cloudbase-code-review, fix errors, declare done

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, start from the CloudBase main entry:

  • CloudBase main entry: https://cnb.cool/tencent/cloud/cloudbase/cloudbase-skills/-/git/raw/main/skills/cloudbase/SKILL.md
  • Sibling skill pattern: https://cnb.cool/tencent/cloud/cloudbase/cloudbase-skills/-/git/raw/main/skills/cloudbase/references/<skill-id>/SKILL.md

Replace <skill-id> with the published directory name. Follow relative references/... paths from the current skill. If MCP is unavailable, read cloudbase and follow references/mcp-setup.md / mcporter setup first.

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.
  • Use MCP or mcporter first for management tasks; inspect tool schemas before execution.
  • 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; 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 envQuery(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="createApp", ...). 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 via MCP before writing frontend code. Auth providers, tables, storage domains, and security rules first.
  • 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.

High-priority routing

ScenarioRead firstThen readDo NOT route to firstMust check before action
Web login / registration / auth UIauth-tool-cloudbaseauth-web, web-developmentcloud-functions, http-apiProvider status and publishable key
WeChat mini program + CloudBaseminiprogram-developmentauth-wechat, no-sql-wx-mp-sdkauth-web, web-developmentWhether the project really uses CloudBase / wx.cloud
Native App / Flutter / React Nativehttp-api-cloudbaseauth-tool, relational-database-toolauth-web, cloudbase-document-database-web-sdk, web-developmentSDK boundary, OpenAPI, auth method
Web projects + NoSQL Databaseweb-developmentno-sql-web-sdk, auth-webrelational-database-tool, http-apiLogin state and database access permission model
CloudBase PostgreSQL / PGpostgresql-development-cloudbaseauth-tool, auth-web-cloudbase, web-development, miniprogram-development, cloud-storage-web, http-apirelational-database-tool, no-sql-web-sdkPG schema, usernamePassword login, backend/RLS permission model
MySQL Database (relational)relational-database-mcp-cloudbaserelational-database-web, http-apino-sql-web-sdk, web-developmentDistinguish MCP management vs app code access
Cloud Functionscloud-functionsauth-tool, ai-model-nodejscloudrun-development, auth-webEvent vs HTTP function, runtime, scf_bootstrap
CloudRun backendcloudrun-developmentauth-tool, relational-database-toolcloud-functionsContainer boundary, Dockerfile, CORS
AI Agent (智能体开发)cloudbase-agentcloud-functions, cloudrun-developmentcloud-functions, cloudrun-developmentAG-UI protocol, scf_bootstrap, SSE streaming
AI model call (大模型调用 / 文本生成 / 图片生成 / 流式对话)ai-model-webai-model-nodejs, ai-model-wechatcloudbase-agent, cloud-functions, cloudrun-development先跑「调用前必须的资格检查」:DescribeActivityInfo(小程序成长计划) + DescribeEnvPostpayPackage(Token Credits 资源包)
UI generationui-designweb-development, miniprogram-developmentcloud-functionsDesign specification first
AI Model (Web)web-developmentai-model-web, ui-designai-model-wechat, http-apiPlatform and streaming interaction mode
Resource health inspection / troubleshootingops-inspectorcloud-functions, cloudrun-developmentui-design, spec-workflowCLS enabled, time range for logs
Spec workflow / architecture designspec-workflowcloudbaseweb-development, cloud-functionsRequirements, design, tasks confirmed

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.
  • 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 / DescribeActivityInfo before changing code.

MCP prerequisite

CloudBase MCP is required for management/deploy. Setup details: references/mcp-setup.md. Verify with npx mcporter list | grep cloudbase or the IDE MCP panel before any CloudBase tool call. Prefer device-code login via auth; do not hard-code secrets.

On-demand references

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

  • references/deployment-workflow.md — deploy backend/frontend, manageApps vs hosting, URL/docs updates
  • references/console-links.md — console hash paths after creating resources
  • references/scenarios.md — user-need → CloudBase capability mapping
  • references/mcp-setup.md — IDE MCP / mcporter config and auth examples
  • references/activation-map.yaml — canonical routing contract source
Repository
TencentCloudBase/CloudBase-AI-Toolkit
Last updated
First committed

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.