CloudBase platform overview and routing guide. This skill should be used when users need high-level capability selection, platform concepts, console navigation, realtime (broadcast / presence / live database changes), or cross-platform best practices before choosing a more specific implementation skill.
84%
Does it follow best practices?
Run evals on this skill
Adds up to 20 points to the overall score
Medium
Suggest reviewing before use
The canonical home for this skill is cloudbase-platform in TencentCloudBase/CloudBase-AI-Toolkit
Sibling CloudBase skills ship beside this skill. Use local relative paths such as ../auth-tool-cloudbase/SKILL.md.
If a referenced sibling skill file is missing from this environment, ask the user to install the full CloudBase plugin (or the missing skill). Do not HTTP-fetch remote skill or protocol markdown into the agent context.
Cross-cutting protocols (required before code changes or deployments):
references/protocols/change-safety-protocol.mdreferences/protocols/deployment-gate.mdreferences/protocols/sensitive-runtime-data-protection.mdPost-deployment (optional, non-intrusive): after a deployment is verified successful, you may offer at most once to generate anonymized shareables (Deployment Share) — see references/protocols/deployment-share.md. Deliver the card, the copy and the case-wall entry in one reply; shareables only if that is all the user asked for. Never follow up if declined; never publish or submit on the user's behalf.
../minimal-web-baas-demo/SKILL.md
queryEnv → lock one DB plane → MCP schema → @cloudbase/js-sdk CRUD → preview.../web-development/SKILL.md../auth-tool-cloudbase/SKILL.md, ../auth-web-cloudbase/SKILL.md../miniprogram-development/SKILL.md../cloudbase-wechat-integration/SKILL.md (official docs: https://docs.cloudbase.net/integration/introduce.md)../cloud-functions/SKILL.md../http-api-cloudbase/SKILL.md../cloudbase-document-database-web-sdk/SKILL.md or ../cloudbase-document-database-in-wechat-miniprogram/SKILL.md../postgresql-development-cloudbase/SKILL.md../postgresql-development-cloudbase/references/realtime.md
describeRealtime only reads settings, so do not call enableRealtime as a routine step — ask the user before provisioning.app.realtime() (Broadcast / Presence / Postgres CDC) is not document-database collection.watch(). Do not answer a realtime request with watch() code, or the reverse.../postgresql-development-cloudbase/SKILL.md; existing MySQL only -> ../relational-database-mcp-cloudbase/SKILL.md../cloud-storage-web/SKILL.mdcloudbase-platform/references/protocols/change-safety-protocol.md).cloudbase-platform/references/protocols/deployment-gate.md.x-cloudbase-context, full req.headers, or process.env from Cloud Functions / CloudRun (including httpbin-style debug images) — follow references/protocols/sensitive-runtime-data-protection.md.Use this skill for CloudBase platform knowledge when you need to:
This skill provides foundational knowledge that applies to all CloudBase projects, regardless of whether they are Web, Mini Program, or backend services.
Understand platform differences
Follow best practices
@cloudbase/js-sdk direct DB access for browser CRUD; use cloud functions only for secrets, scheduled/background jobs, or elevated cross-collection logic that security rules / RLS cannot express (see ../minimal-web-baas-demo/SKILL.md for the demo default)Use correct SDKs and APIs
postgresql-development-cloudbase; do not reuse NoSQL app.database() / db.collection(...) snippets or MySQL queryMysqlDatabase / manageMysqlDatabase for PG data pathsqueryEnv tool to get environment IDsrc/lib/backend.*, src/lib/auth.*, src/lib/*service.*, and bound page handlers before broad concept reading.Use the canonical CloudBase MCP setup from the main cloudbase guideline
cloudbase guideline firsttcb CLI now (../cloudbase-cli/SKILL.md, ../cloudbase/references/tooling-fallback.md). Inspect tool schemas before MCP execution. Do not hard-code Secret ID / Secret Key / Env ID in configauth, while application-side auth configuration uses queryAppAuth / manageAppAuthWhen working with domain-related tasks, use the correct tool based on the requirement:
| Requirement | Tool | Parameters | Purpose |
|---|---|---|---|
| Security Domain (安全域名) | manageEnv(action="addSecurityDomain" | "removeSecurityDomain") | domains (array of host:port strings) | CORS/request source validation for browser uploads. No certificate involved. (Deprecated alias: envDomainManagement.) |
| Reuse existing Custom Domain | queryGateway(listCustomDomains) → manageGateway(createRoute) | domain = existing custom domain; route fields | Expose a service/path on an already-bound custom domain. No certificateId. Prefer this when a custom domain already exists. |
| Bind new Custom Domain (自定义域名) | manageGateway(action="bindCustomDomain") | domain (string), certificateId (string) | First-time bind of a new public HTTPS domain. Requires certId from SSL console. |
| Delete Custom Domain | manageGateway(action="deleteCustomDomain") | domain (string) | Remove custom domain binding (only after routes on that domain are deleted). |
| Disable / enable gateway route | manageGateway(action="disableRoute" | "enableRoute") | path (required), prefer explicit domain | Toggle Routes[].Enable via ModifyHTTPServiceRoute (not ModifyGatewayRoute). |
| Disable static hosting default domain | queryGateway(listRoutes) → manageGateway(disableRoute) | domain = *.tcloudbaseapp.com (DomainType=STATIC_STORE, IsDefault=true), usually path="/" | Turns off public access on the shared hosting CDN default host. Do not use manageHosting. |
Key indicators for choosing the right tool:
listCustomDomains then createRoute(domain=...) (no certificateId)manageGateway(action="bindCustomDomain")manageEnv(action="addSecurityDomain" / "removeSecurityDomain")createRoute when possible; only bindCustomDomain for first-time domain bind*.tcloudbaseapp.com → queryGateway(listRoutes) then manageGateway(disableRoute) with that STATIC_STORE domain; never invent ModifyGatewayRoute../cloud-api-operations/references/recipes/custom-domain.md: run the read-only VerifyHTTPServiceRoute pre-check first, then bind, then poll Status / DNSStatus. That recipe also covers why domain registration / DNS / ICP calls may return UnauthorizedOperation for an account-level identity.When a CloudBase tool call fails and the error message contains a specific error code (pattern Category.Code, e.g. OperationDenied.FreePackageDenied, ResourceNotFound.*), always route through the official docs before acting — do not guess the meaning, do not hardcode fix recipes here:
searchKnowledgeBase(mode="docs", action="searchDocs", query="<错误码>") — official docs search covers error-code pages. Act on the documented meaning and the fix steps the doc prescribes (plan limits → upgrade guidance, misconfiguration → config fix, etc.).https://docs.cloudbase.net/error-code/basichttps://cloud.tencent.com/document/product/876/34823https://cloud.tencent.com/document/product/876/127357 rather than assuming which tier unlocks it.Billing and service-stop codes are a special case: the code's own reading is misleading, so diagnose before acting. When a failure is InsufficientBalance (a cloud function answers it with HTTP 410), EXCEED_REQUEST_LIMIT, or a service that is simply down, InsufficientBalance reads as an account problem and is not one: what runs out is the environment's resource points, which are drawn down ahead of any account balance (plan quota → resource packs → pay-as-you-go) and are not restored by a top-up. The official status-code table for the serverless service says "top up and retry", so a reader who follows the text sends the user to the account and the failure stays.
Diagnose first, then advise — four causes need four different answers (free-trial points exhausted / paid plan points exhausted / plan expired / account genuinely in arrears), and only the last one involves topping up. Run manageEnv(action="usage") for the environment's credit usage for the current cycle and read the account balance alongside it (callCloudApi, billing), both read-only; the decision table, per-plan remedies and the console entries are in credits-exhaustion. Two facts to carry into any advice: a free trial cannot buy resource packs or enable pay-as-you-go (upgrading to a paid plan is the only path), and the plan names are exactly 免费体验版 / 个人版 / 标准版 / 企业版 / 企业高级版.
When a task explicitly requires recording operation steps or results to a file (e.g., RESULT.json): perform the tool calls first, then write a complete record containing every attempt (action, success/failure, message) plus a summary with total / succeeded / failed counts. Do not write the file from memory before the calls finish.
Static Hosting vs Cloud Storage:
manageStorage / queryStorage), not manageHosting(action="upload")Static Hosting Domain:
queryHosting(action="websiteConfig")<envId>-<appId>.tcloudbaseapp.com (DomainType=STATIC_STORE, often IsDefault=true in queryGateway(listRoutes))manageGateway(action="disableRoute", domain="<that-host>", path="/") (or updateRoute with enable=false). Re-enable with enableRoute. Do not look for a manageHosting disable-default-domain action; do not call non-existent ModifyGatewayRoute — the API is ModifyHTTPServiceRoute/Cloud Storage Public URL:
manageStorage(action=upload) and queryStorage(action=url) return temporaryUrl which is a temporary signed URL that expires (default 1 hour). Do NOT use this as a permanent public URL.queryEnv(action=info) to get environment detailsEnvInfo.Storages[0].CdnDomain (e.g., your-env-id.tcb.qcloud.la)https://{CdnDomain}/{cloudPath}CdnDomain is env-xxx.tcb.qcloud.la and cloudPath is uploads/avatar.jpg, the public URL is https://env-xxx.tcb.qcloud.la/uploads/avatar.jpgPRIVATE which requires signed URLs)Shared-Bucket (ExternalStorage) Environments:
queryEnv(action="info"): cloud storage uses a shared bucket when EnvInfo.Storages[0].Bucket is empty and Storages[0].ExternalStorage.Enabled === true; check static hosting the same way on EnvInfo.StaticStorages[0]. Storage and hosting can use different buckets and BasePaths.cloudPath exactly as in a normal environment and never prepend the BasePath or bucket name. Example: with BasePath tenant-a, upload with cloudPath="images/a.png", not "tenant-a/images/a.png" (that nests the file under tenant-a/tenant-a/). Build hosting and CDN URLs from the logical path too — the domain resolves the BasePath, and adding it to a hosting URL returns 404.manageHosting(action="setWebsiteDocument") changes a bucket-level setting that would affect every environment in the bucket, so it fails on shared-bucket hosting. Reading with queryHosting(action="websiteConfig") still works. Tell the user this setting is managed by the platform instead of retrying.SDK Initialization:
queryEnv toolqueryEnv(action="list", alias=..., aliasExact=true) first and use the returned full EnvIdauth.set_env, console URLs, or generated config filesimport cloudbase from "@cloudbase/js-sdk"; const app = cloudbase.init({ env: "your-full-env-id" });import("@cloudbase/js-sdk") or async wrappers such as initCloudBase() with internal initPromiseEnvironment Management (via manageEnv):
The manageEnv tool provides full lifecycle management for CloudBase environments.
| Action | Description | Key Parameters |
|---|---|---|
listPackages | Query available plans | (none) |
create | Create new environment (needs confirm) | alias, packageId, resources, duration, region, externalStorage |
modifyPlan | Change plan (upgrade/downgrade, needs confirm) | envId, packageId |
renew | Renew environment (needs confirm) | envId, duration |
Creating an environment with specific resources:
manageEnv(action="create", alias="my-env", packageId="baas_personal",
resources=["storage","function","postgresql"], confirm="yes")resources (optional, create only): controls which CloudBase capabilities to enable:
storage — Cloud Storagefunction — Cloud Functionspostgresql — PostgreSQL relational database (PG mode)Resources to CreateEnv.flexdb (document database) is not offered: new environments are created without a NoSQL tenant. Do not pass it — it is rejected by the schema. To find out whether an environment actually has NoSQL, read queryEnv(action="info") → EnvInfo.RuntimeBackends rather than assuming.region (e.g. region="ap-shanghai") to choose where the environment is created. It is applied as the X-TC-Region request context, not as a CreateEnv body field — so do not put Region inside params. Omit it to use the current session region (cloudBaseOptions.region → TCB_REGION → project config / rc binding → site default: ap-shanghai for the domestic site, ap-singapore for the intl site). Equivalent CLI: tcb env create --region ap-shanghai.region, repeat the same value on the confirming call together with confirm="yes"; otherwise the second call falls back to the session region and the environment may be created somewhere other than the summary you confirmed.externalStorage (optional, create only): { bucketName, region, basePath } creates the environment's cloud storage on an existing shared COS bucket instead of a dedicated one, isolating its files under basePath (must be unique within the bucket). All three fields are required when the object is passed. Use it only when the user provides the bucket — typically a platform creating many environments under one account, where one bucket per environment would hit the account's COS bucket quota; never invent bucket names. It does not cover static hosting: the hosting bucket is chosen by the platform when hosting is enabled and cannot be set through this tool.region, repeat the same externalStorage on the confirm="yes" call. The confirming call reads only its own arguments, so leaving it out creates the environment with a dedicated bucket instead.manageEnv(action="create", alias="tenant-a", packageId="baas_personal",
externalStorage={ bucketName: "shared-bucket-1250000000", region: "ap-shanghai", basePath: "tenant-a" },
confirm="yes")confirm="yes".Querying available packages before creating:
manageEnv(action="listPackages")baas_personal (个人版), baas_pf_standard (标准版), baas_pf_enterprise (企业版), baas_pf_enterprise_senior (企业高级版), baas_trial (体验版), baas_integration (集成版). Package families (default / basic / trial / vip) do not map onto that set — legacy packages such as starter (入门版), baas_team (团队版) and enterprise_basic (企业基础版) share families with the current ones and are deliberately excluded. The platform still accepts other valid packageIds, so the actual create result is authoritative.Changing plan (use a packageId from listPackages):
manageEnv(action="modifyPlan", envId="your-env-id", packageId="<packageId>", confirm="yes")Renewing an environment:
manageEnv(action="renew", envId="your-env-id", duration=1, confirm="yes")Important: Authentication methods for different platforms are completely different, must strictly distinguish!
auth.getVerification(), for detailed, refer to web auth related docsauth.getSession() and require data.session; do not use deprecated getLoginState() or auth.getUser() / auth.getCurrentUser() as proof of real login.queryAppAuth / manageAppAuth, not the MCP auth toolaccessKey alone does not create a gateway-authenticated anonymous session. With @cloudbase/js-sdk 3.x, call await auth.signInAnonymously() (or an equivalent authenticated session) before NoSQL app.database() CRUD, or the gateway returns 401. If the app uses AuthGuard or RLS for access control, ensure is_anonymous checks are in place when anonymous access is allowed.auth.uid(), NOT current_user. When writing RLS policies for CloudBase PostgreSQL, the user identity must use auth.uid() (returns the JWT sub / actual user ID as text, not uuid — unlike Supabase). Prefer owner columns as varchar(64) / text; if the column is uuid, cast with auth.uid()::uuid or you get operator does not exist: uuid = text. Do NOT use current_user or current_setting(...) — these PostgreSQL built-in functions return the database role name (e.g. authenticated), not the CloudBase auth user ID. CloudBase PG provides four auth helper functions: auth.uid(), auth.role(), auth.email(), auth.jwt(). Verify availability with SELECT proname FROM pg_proc WHERE pronamespace = 'auth'::regnamespace.wxContext.OPENID via wx-server-sdkpackage.json, declaring required dependenciesmanageFunctions(action="createFunction") to create functionsmanageFunctions(action="updateFunctionCode") to deploy cloud functionsfunctionRootPath refers to the parent directory of function directories, e.g., cloudfunctions directory⚠️ CRITICAL: Always configure permissions BEFORE writing database operation code!
Permission Model:
Platform Compatibility (CRITICAL):
ADMINWRITE or ADMINONLY for write operationsConfiguration Workflow:
Create collection → Configure security rules → Write code → TestmanagePermissions(action="updateResourcePermission") to configure resource permissionsno-sql-web-sdk/security-rules.md for detailed resourceType="noSqlDatabase" examples only; do not treat doc._openid, auth.openid, query-subset validation, or create / update / delete JSON templates as generic rules for functions, storage, or SQL tableshttps://cloud.tencent.com/document/product/876/41802https://docs.cloudbase.net/database/security-ruleshttps://docs.cloudbase.net/cloud-function/security-ruleshttps://docs.cloudbase.net/storage/security-rulesCompatibility note:
permissionssecurity-rule, security-rules, secret-rule, secret-rules, and access-control still resolve to the permissions pluginreadSecurityRule / writeSecurityRule are removed; prefer queryPermissions / managePermissionsCommon Scenarios:
READONLY (admin manages via cloud functions)CUSTOM with auth.uid check (users manage their own)CUSTOM with ownership validationPRIVATE or ADMINONLYCross-Collection Operations:
../minimal-web-baas-demo/SKILL.mdCloudBase MCP provides role management via queryPermissions and managePermissions (CLI equivalent: tcb role). See each tool's schema for the full action list.
⚠️ CRITICAL: Role policies and resource permissions are two independent systems with NO automatic synchronization.
Query (queryPermissions): listRoles, getRole (by roleId / roleIdentity / roleName).
Manage (managePermissions): createRole, updateRole, deleteRoles, addRoleMembers, removeRoleMembers, addRolePolicies, removeRolePolicies.
managePermissions(action="createRole", roleName="Developer", roleIdentity="developer",
policies=["FunctionsAccess"], memberUids=["user-uid-1"])⚠️ Only custom roles can be deleted. System roles are read-only.
See also: CLI equivalent commands in cloudbase-cli/references/permission.md
@cloudbase/js-sdk → database (see ../minimal-web-baas-demo/SKILL.md)Get Data Model Operation Object:
@cloudbase/wx-cloud-client-sdk, initialize const client = initHTTPOverCallFunction(wx.cloud), use client.models@cloudbase/node-sdk@3.10+, initialize const app = cloudbase.init({env}), use app.models@cloudbase/js-sdk, initialize const app = cloudbase.init({env}), after login use app.modelsData Model Query:
manageDataModel tool to:
MySQL Data Model Invocation Rules:
db.collection('model_name').get()app.models.model_name.list({ filter: { where: {} } })manageDataModel tool's docs method to get specific SDK usageAfter creating/deploying resources, provide corresponding console links. All console URLs follow the pattern: https://tcb.cloud.tencent.com/dev?envId=${envId}#/{path} — replace ${envId} with the real EnvId resolved via queryEnv (resolve aliases first; see Environment and Authentication below), and resource names with actual values.
The CloudBase console is updated frequently. If a live, logged-in console shows a different hash path from this list, prefer the live console path over stale documentation and then update this skill to match.
#/overview#/cloud-template/market#/db/doc · Collections #/db/doc/collection/${collectionName} · Models #/db/doc/model/${modelName}#/db/mysql · Tables #/db/mysql/table/default/ (must be enabled in console first)#/db/postgres · Data editor #/db/postgres/data-editor · SQL editor #/db/postgres/sql-editor · Settings #/db/postgres/setting (instance spec, account password) · Tasks #/db/postgres/tasks (async task list: spec change, share-to-dedicated upgrade) · Backups #/db/postgres/backups · Migrations #/db/postgres/migrations#/scf · Detail #/scf/detail?id=${functionName}&NameSpace=${envId}#/platform-run (a per-environment capability that must be provisioned first — manageCloudRun(action="initEnv"), then poll queryCloudRun(action="envStatus") until normal; an env can exist without CloudRun, and in that case CloudRun APIs still return success with empty fields)#/storage#/ai#/static-hosting (alt: https://console.cloud.tencent.com/tcb/hosting)#/identity · Login management #/identity/login-manage · Token management #/identity/token-management#/lowcode/apps#/devops/log#/env/env-setting (env info, QPS overage, preview state)#/env/http-access (security domains, CORS, env vars, quotas)#/env/filing-manage (whether this env qualifies as a filing resource: package tier, remaining validity > 6 months, CloudRun fixed IP; unmet items carry their own "renew" / "enable fixed IP" buttons)For configuration pages (like login management), guide users through the setup process rather than only dropping a link.
All packaged reference files (required for skill lint reachability):
TencentCloudBase/CloudBase-AI-Toolkit
78c7128
Canonical home
since Sep 30, 2026
Also appears in
since Sep 30, 2026
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.