cloudbase

Files (200)

• LICENSE.md
• SKILL.md
• activation-map.yaml · references/
• LICENSE.md · references/ai-model-nodejs/
• SKILL.md · references/ai-model-nodejs/
• api-reference.md · references/ai-model-nodejs/references/
• custom-onboarding.md · references/ai-model-nodejs/references/
• LICENSE.md · references/ai-model-web/
• SKILL.md · references/ai-model-web/
• LICENSE.md · references/ai-model-wechat/
• SKILL.md · references/ai-model-wechat/
• LICENSE.md · references/auth-nodejs-cloudbase/
• SKILL.md · references/auth-nodejs-cloudbase/
• LICENSE.md · references/auth-tool-cloudbase/
• SKILL.md · references/auth-tool-cloudbase/
• checklist.md · references/auth-tool-cloudbase/
• extended-guide.md · references/auth-tool-cloudbase/references/
• LICENSE.md · references/auth-web-cloudbase/
• SKILL.md · references/auth-web-cloudbase/
• extended-guide.md · references/auth-web-cloudbase/references/
• LICENSE.md · references/auth-wechat-miniprogram/
• SKILL.md · references/auth-wechat-miniprogram/
• extended-guide.md · references/auth-wechat-miniprogram/references/
• LICENSE.md · references/cloud-api-operations/
• SKILL.md · references/cloud-api-operations/
• calling-methods.md · references/cloud-api-operations/references/
• README.md · references/cloud-api-operations/references/recipes/
• billing-charges-explained.md · references/cloud-api-operations/references/recipes/
• cloud-audit-operation-trace.md · references/cloud-api-operations/references/recipes/
• credits-exhaustion.md · references/cloud-api-operations/references/recipes/
• custom-domain.md · references/cloud-api-operations/references/recipes/
• icp-filing-readiness.md · references/cloud-api-operations/references/recipes/
• pg-instance-spec.md · references/cloud-api-operations/references/recipes/
• pg-storage-alarm.md · references/cloud-api-operations/references/recipes/
• platform-agent-connect.md · references/cloud-api-operations/references/recipes/
• platform-agent-guardrails.md · references/cloud-api-operations/references/recipes/
• platform-onboarding.md · references/cloud-api-operations/references/recipes/
• platform-usage-and-recycle.md · references/cloud-api-operations/references/recipes/
• service-versions.md · references/cloud-api-operations/references/
• LICENSE.md · references/cloud-functions/
• SKILL.md · references/cloud-functions/
• checklist.md · references/cloud-functions/
• references.md · references/cloud-functions/
• event-functions.md · references/cloud-functions/references/
• http-function-credentials.md · references/cloud-functions/references/
• http-functions-custom-image.md · references/cloud-functions/references/
• http-functions.md · references/cloud-functions/references/
• operations-and-config.md · references/cloud-functions/references/
• vpc-and-tcp-database.md · references/cloud-functions/references/
• LICENSE.md · references/cloud-storage-web/
• SKILL.md · references/cloud-storage-web/
• LICENSE.md · references/cloudbase-agent/
• SKILL.md · references/cloudbase-agent/
• LICENSE.md · references/cloudbase-agent/py/
• adapter-coze.md · references/cloudbase-agent/py/
• adapter-development.md · references/cloudbase-agent/py/
• adapter-langgraph.md · references/cloudbase-agent/py/
• agent-deployment.md · references/cloudbase-agent/py/
• authentication.md · references/cloudbase-agent/py/
• observability.md · references/cloudbase-agent/py/references/
• …and 140 more

SKILL.md (first lines)

# 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.

| | 国内站 domestic | 国际站 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 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`.

## 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`.
- 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-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

<!-- DO NOT EDIT: auto-generated from references/activation-map.yaml -->

| 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` |

From infometa/workbuddyskills, MIT.

More from infometa/workbuddyskills