Skill cloudbase-document-database-web-sdk
✓ VérifiéPermet aux agents d'effectuer des opérations CRUD NoSQL, des requêtes complexes et la synchronisation de données en temps réel dans des applications web via le SDK JS de CloudBase.
- Étoiles GitHub
- 1 164
- Fichiers
- 9
- Dernier commit
- 11 nov. 2026
- Licence
- MIT
- Outils autorisés
- —
Que fait la skill cloudbase-document-database-web-sdk ?
Permet aux agents d'effectuer des opérations CRUD NoSQL, des requêtes complexes et la synchronisation de données en temps réel dans des applications web via le SDK JS de CloudBase.
Résumé généré à partir du SKILL.md de la skill.
À propos du skill cloudbase-document-database-web-sdk
Les développeurs qui construisent des applications web peuvent utiliser cette skill pour implémenter des opérations de base de données documentaire NoSQL directement dans leur code frontend. Elle est conçue pour les agents chargés d'écrire ou de modifier du JavaScript côté navigateur en utilisant le @cloudbase/js-sdk pour gérer les collections de données. La skill facilite les tâches CRUD standards, les requêtes complexes, la pagination et l'agrégation de données, ainsi que la synchronisation en temps réel via la méthode watch.
Lorsqu'un agent doit implémenter une logique applicative ou modifier des fichiers de projet web existants, il doit charger cette skill pour produire des implémentations SDK correctes. Elle s'appuie sur le SDK JS de CloudBase et nécessite une coordination rigoureuse avec les états d'authentification pour garantir le respect des règles de sécurité. Cette skill est spécifiquement destinée aux environnements basés sur le navigateur et ne doit pas être utilisée pour les fonctions cloud côté serveur, le développement de Mini Program ou les opérations PostgreSQL basées sur SQL.
Ce qu'un agent peut faire avec
- 1Implémenter des opérations CRUD frontendUn agent peut écrire du code JavaScript pour ajouter, récupérer, mettre à jour ou supprimer des documents dans une collection spécifique.
- 2Configurer des écouteurs de données en temps réelUn développeur peut demander à une IA d'implémenter des mises à jour de données en direct dans une interface web en utilisant la méthode watch.
- 3Développer des flux de données paginésUn agent peut créer une logique pour récupérer de grands ensembles de données par blocs gérables en utilisant les commandes skip et limit.
Rédigé à partir du SKILL.md du skill. Chaque cas d'utilisation est vérifié par rapport à une citation de celui-ci.
Comment installer la skill cloudbase-document-database-web-sdk
Chaque commande copie le dossier de la skill dans le répertoire des skills du client. Redémarrez le client ou démarrez une nouvelle session pour la charger.Installer la skill cloudbase-document-database-web-sdk dans Claude Code
~/.claude/skills/cloudbase-document-database-web-sdk/SKILL.md
$ npx degit TencentCloudBase/CloudBase-AI-Toolkit/config/.claude/skills/cloudbase-document-database-web-sdk ~/.claude/skills/cloudbase-document-database-web-sdkInstaller la skill cloudbase-document-database-web-sdk dans Claude Code (project)
.claude/skills/cloudbase-document-database-web-sdk/SKILL.md
$ npx degit TencentCloudBase/CloudBase-AI-Toolkit/config/.claude/skills/cloudbase-document-database-web-sdk .claude/skills/cloudbase-document-database-web-sdkInstaller la skill cloudbase-document-database-web-sdk dans Codex
~/.agents/skills/cloudbase-document-database-web-sdk/SKILL.md
$ npx degit TencentCloudBase/CloudBase-AI-Toolkit/config/.claude/skills/cloudbase-document-database-web-sdk ~/.agents/skills/cloudbase-document-database-web-sdkInstaller la skill cloudbase-document-database-web-sdk dans Gemini CLI
~/.gemini/skills/cloudbase-document-database-web-sdk/SKILL.md
$ npx degit TencentCloudBase/CloudBase-AI-Toolkit/config/.claude/skills/cloudbase-document-database-web-sdk ~/.gemini/skills/cloudbase-document-database-web-sdkInstaller la skill cloudbase-document-database-web-sdk dans Claude.ai
npx degit TencentCloudBase/CloudBase-AI-Toolkit/config/.claude/skills/cloudbase-document-database-web-sdk cloudbase-document-database-web-sdk && zip -r cloudbase-document-database-web-sdk.zip cloudbase-document-database-web-sdk # claude.ai → Customize → Skills → + → Create skill → Upload a skill → cloudbase-document-database-web-sdk.zip
Vérifications automatisées
Exécuté le 15 nov. 2026Rapport complet →A réussi nos vérifications automatiques. Ce n'est pas un audit de sécurité : lisez les scripts avant de laisser un agent les exécuter. Fonctionnement des vérifications · Ce qu'il faut corriger pour gagner des points
- Dépôt source lié et accessibletencentcloudbase/cloudbase-ai-toolkit/config/.claude/skills/cloudbase-document-database-web-sdk is public and reachablegithub.com/tencentcloudbase/cloudbase-ai-toolkit/tree/HEAD/c ↗Réussi
- Licence open source (OSI)MITspdx.org/licenses/MIT.html ↗Réussi
- Commit ou version publiée au cours de l'année écouléeLast commit 2026-11-11github.com/tencentcloudbase/cloudbase-ai-toolkit/commits ↗Réussi
- Aucun téléchargement-exécution ni vol d'identifiants dans les scriptsNo scripts in the skill folderRéussi
- Aucune instruction cachée dans SKILL.mdNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/tencentcloudbase/cloudbase-ai-toolkit/blob/HEAD/c ↗Réussi
- Les outils préautorisés sont limitésNo pre-approved tools; the agent asks before using onegithub.com/tencentcloudbase/cloudbase-ai-toolkit/blob/HEAD/c ↗Réussi
- SKILL.md respecte le format Agent Skillsthe description does not say when to use the skillgithub.com/tencentcloudbase/cloudbase-ai-toolkit/blob/HEAD/c ↗Faille
SKILL.md
Voir sur GitHubSibling skills (local only)
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.
CloudBase Document Database Web SDK
Activation Contract
Use this first when
- A browser or Web app must read or write CloudBase document database data through
@cloudbase/js-sdk. - The request mentions
app.database(),db.collection(),.where(),.watch(), pagination, aggregation, or geolocation queries in a Web frontend.
Read before writing code if
- The task is clearly browser-side, but you still need to decide between Web SDK, Mini Program SDK, or backend access.
- The request touches login state, collection permissions, or realtime updates.
Then also read
- Web login and caller identity ->
../auth-web-cloudbase/SKILL.md - General Web app structure ->
../web-development/SKILL.md - Mini Program database code ->
../cloudbase-document-database-in-wechat-miniprogram/SKILL.md
Do NOT use for
- Mini Program code using
wx.cloud.database(). - Server-side or cloud-function database access.
- SQL / MySQL database operations.
- Pure resource-permission administration with no browser SDK code.
- NEW business tables that the task explicitly asks to put in CloudBase PostgreSQL (CloudBase PG). Before applying this skill, call
queryEnv(action="info", envId=...)and readEnvInfo.RuntimeBackends. Ifpostgresql === trueAND the task asks for a new business table to live in PG, switch to thepostgresql-development-cloudbaseskill for that table: it goes throughapp.rdb(), uses PG row-level security (CREATE POLICY), and uploads viaapp.storage.from('<bucket>').upload('<key>', file)against an explicitly-created pgstore bucket.- Existing NoSQL collections in the same env keep using THIS skill — PG and NoSQL coexist in CloudBase PG environments. The rule is "follow the task / existing surface", not "PG env forbids NoSQL".
- Moving existing document data onto PG without changing the client code is pgdoc, not a rewrite to
app.rdb(). Read../postgresql-development-cloudbase/references/pgdoc.md: SDK calls and HTTP paths stay the same, but CUSTOM security rules no longer apply and data is not migrated automatically.
SDK Code vs MCP Tools
When to write SDK code (use this skill):
- The task explicitly asks to "modify code" or "use SDK"
- The task asks to implement app/frontend logic
- The task mentions specific SDK methods like
db.collection().add(),.get(),.update() - The context shows an existing Web project with SDK initialization (e.g.,
index.jsalready hascloudbase.init())
When to use MCP tools instead:
- The task asks to manage CloudBase resources (create collection, set permissions, etc.)
- The task involves admin/management operations without writing app code
- The task mentions tools like
writeNoSqlDatabaseContent,managePermissions, etc.
Key distinction: If the user says "使用 JS SDK 执行 XX 操作" (use JS SDK to perform XX operation) or "修改代码" (modify code), write SDK code in the project files. Do not use MCP database write tools for app-level data operations.
Common mistakes / gotchas
- Querying before the user is signed in when the collection rules require identity.
- Using
wx.cloud.database()or Node SDK patterns in browser code. - Initializing CloudBase lazily with dynamic imports instead of a shared synchronous app instance.
- Treating security rules as result filters rather than request validators.
- Expecting a
CUSTOMsecurity rule to take effect immediately after you callmanagePermissions(updateResourcePermission). The backend caches rule evaluators for 2–5 minutes; first writes after a rule change may silently fail or be rejected withDATABASE_PERMISSION_DENIEDeven when the expression is correct. Either (a) wait a few minutes and retry the same write before assuming the rule is wrong, or (b) verify the rule is live by readingresult.code/result.messageon every write and by doing aget()round-trip on the just-written_id; do not treat a resolved promise as success. Seesecurity-rules.md→ "Propagation And Verification" for the full pattern. - Misreading the return shape of
db.collection(...).add(...). In the CloudBase Web SDK, the created document ID is exposed at top-levelresult._id, notresult.id,result.data.id, orresult.insertedId. - For CMS-style collections that need app-level admin users to edit/delete all records while editors can only edit/delete their own records, do not oversimplify the rule to
READONLY. A validated pattern is aCUSTOMrule that reads role fromuser_rolesbyauth.uidand combines it withdoc.authorId == auth.uid, while frontend writes can stay on.doc(id).update()/.doc(id).remove(). - Forgetting pagination or indexes for larger collections.
Minimal checklist
- Confirm this is browser-side document database work.
- Initialize CloudBase once and reuse the same
app/dbinstance. - Verify auth expectations before CRUD.
- Read the right companion reference file for the specific operation.
Overview
This skill covers browser-side document database usage via @cloudbase/js-sdk.
Use it for:
- CRUD in a Web app
- complex queries and pagination
- aggregation
- realtime listeners with
watch() - geolocation queries
Canonical initialization
import cloudbase from "@cloudbase/js-sdk";
const app = cloudbase.init({
env: "your-env-id"
});
const db = app.database();
const _ = db.command;
Important rules:
- Sign in before querying if the collection rules require identity.
- Keep a single shared app/database instance.
- Do not hide initialization inside ad-hoc async loaders unless the framework truly requires it.
Quick routing
- CRUD ->
./crud-operations.md - Complex queries ->
./complex-queries.md - Pagination ->
./pagination.md - Aggregation ->
./aggregation.md - Realtime listeners ->
./realtime.md - Geolocation ->
./geolocation.md - Security rules ->
./security-rules.md
Working rules for a coding agent
-
Start from the auth model
- If the page relies on logged-in user identity, read the Web auth skill before writing database code.
-
Keep browser code browser-native
- Use
app.database()and collection references. - Do not mix in MCP management flows or SQL mental models.
- Use
-
Respect security rules
- Collection rules can reject requests before data is read.
- If the requirement is simple owner-only write access,
READONLYcan be enough. - If the requirement is “app-level admin can edit/delete all, editor only own”, use a
CUSTOMrule. A validated CMS pattern isget(`database.user_roles.${auth.uid}`).role == 'admin' || doc.authorId == auth.uid. - For that CMS pattern, frontend writes can stay on
.doc(id).update()/.doc(id).remove(). - Reuse whichever role collection already exists and can be addressed by
_id == auth.uid. In this CMS pattern,user_roleskeyed by uid is acceptable. - A
get()whose target document is missing fails the request with HTTP 500 — it does not evaluate tofalse, and||does not skip it. If the app cannot guarantee a role document per user, keep the role list in one shared document and testauth.uid in get(`database.admin_registry.lock`).adminsinstead. - If the task fails with permission issues, inspect the rule model rather than assuming the query syntax is wrong.
-
Return user-friendly errors
- Database errors must become readable UI or application errors, not silent failures.
- For writes, do not treat a resolved promise as success by default. Check write result fields such as
updated/deletedor surfacedcode/message.
-
Persist IDs from create operations correctly
- For Web SDK
.add(...), the newly created document ID isresult._id. - Do not look for the ID under
result.id,result.data, or other driver-specific fields.
- For Web SDK
Quick examples
Simple query
const result = await db.collection("todos")
.where({ completed: false })
.get();
Create and capture document ID
const result = await db.collection("posts").add({
title: "New article",
content: "...",
createdAt: new Date()
});
const articleId = result._id;
Ordered pagination
const result = await db.collection("posts")
.orderBy("createdAt", "desc")
.skip(20)
.limit(10)
.get();
Field selection
const result = await db.collection("users")
.field({ name: true, email: true, _id: false })
.get();
Best practices
- Define collection-level types or model wrappers in the app code.
- Use meaningful collection naming conventions.
- Select only required fields.
- Add indexes for frequent filters or sort keys.
- Pair frontend CRUD with explicit permission design.
- Use pagination instead of unbounded reads.
Error handling
try {
const result = await db.collection("todos").get();
console.log(result.data);
} catch (error) {
console.error("Database error:", error);
}
When the SDK returns an operation result, check error indicators and translate them into readable application behavior.
Fichiers de cette skill
9Questions sur la skill cloudbase-document-database-web-sdk
Comment installer la skill cloudbase-document-database-web-sdk dans Claude Code ?
Exécutez npx degit TencentCloudBase/CloudBase-AI-Toolkit/config/.claude/skills/cloudbase-document-database-web-sdk ~/.claude/skills/cloudbase-document-database-web-sdk. Claude Code charge les skills depuis ~/.claude/skills (tous les projets) ou .claude/skills (un seul projet) et utilise une skill lorsque sa description correspond à la tâche.
Quels clients peuvent utiliser la skill cloudbase-document-database-web-sdk ?
Tout client qui lit le format Agent Skills : Claude Code, Codex, Gemini CLI et claude.ai (envoi sous forme de ZIP). Les scripts de la skill ne s'exécutent que si le client autorise l'exécution de code.
Comment obtenir l'ID d'un document nouvellement créé avec le SDK Web ?
L'ID du document nouvellement créé se trouve dans la propriété de premier niveau result._id de la réponse.
Quand dois-je utiliser les outils MCP plutôt que d'écrire du code avec le SDK ?
Utilisez les outils MCP pour les tâches administratives, comme la gestion des ressources CloudBase ou la configuration des permissions, plutôt que pour implémenter la logique frontend de l'application.
Puis-je utiliser cette SKILL pour des opérations PostgreSQL dans CloudBase ?
Non, si la tâche implique PostgreSQL, CloudBase PG ou app.rdb(), vous devez utiliser la skill postgresql-development-cloudbase à la place.