---
name: contentstack-vibe-docs
description: This skill contains ~13,500 lines across 30+ reference files. Read the routing table, pick the 1-3 files you actually need, and stop. Never read everything.
---

# contentstack-vibe-docs

This skill contains ~13,500 lines across 30+ reference files. Read the routing table, pick the 1-3 files you actually need, and stop. Never read everything.

# contentstack-vibe-docsby contentstack
This skill contains ~13,500 lines across 30+ reference files. Read the routing table, pick the 1-3 files you actually need, and stop. Never read everything.

`npx skills add https://github.com/contentstack/contentstack-vibe-docs --skill contentstack-vibe-docs`Download ZIPGitHub

## Contentstack Documentation for AI Agents

This skill contains ~13,500 lines across 30+ reference files. Read the routing table, pick the 1-3 files you actually need, and stop. Never read everything.

## Routing table

TaskFileQuick code pattern lookupQUICK_REFERENCE.mdContentstack basicsconcepts/base-concepts.mdDesign content models, choose references vs modular blocks vs global fields, taxonomyconcepts/data-modeling-best-practices.mdLocalization, fallback chains, non-localizable fieldsconcepts/localization.mdRegions, endpoints, region-aware hostsconcepts/regions.mdFetch content (REST)api/rest-api.mdFetch content (GraphQL)api/graphql-api.mdCreate/update/delete/publish, modular block schema, CMA headersapi/content-management-api.mdTransform images, asset folders, asset limits, file_uidapi/image-delivery-api.mdTypeScript Delivery SDKsdk/delivery-sdk.mdLive Preview overviewlive-preview/concepts.mdLive Preview CSR (`ssr: false`)live-preview/csr-mode.mdLive Preview SSR (`ssr: true`), per-request factory, hash isolationlive-preview/ssr-mode.mdVisual Builder, edit tags, `addEditableTags`, `VB_EmptyBlockParentClass`live-preview/visual-builder.mdDebug Live Preview / Visual Builder failureslive-preview/debugging.mdNext.js patterns, Draft Mode, `revalidateTag`frameworks/nextjs.mdNuxt patternsframeworks/nuxt.mdGatsby patternsframeworks/gatsby.mdPick the right token (delivery/preview/management/authtoken/OAuth)security/tokens-authentication.mdRoles, custom permissions, teamssecurity/roles-permissions.mdOAuth login with Auth.js v5 (Next.js)authentication/oauth.mdWebhooks: signatures, event channels, release stormsworkflows/webhooks.mdReleases: atomic coordinated deploysworkflows/releases.mdWorkflows & publish rulesworkflows/content-workflows.mdBranches & aliases: zero-downtime deploysworkflows/branches-aliases.mdEnvironments, publishing, Sync API, rate limitsworkflows/environments-publishing.mdVariants & Personalizepersonalization/variants-and-personalize.mdCLI plugins — overview & quickstartextensions/cli-plugins/overview.mdCLI plugins — commands, flags, argumentsextensions/cli-plugins/commands.mdCLI plugins — publishing, testing, troubleshootingextensions/cli-plugins/publishing.mdDeveloper Hub apps (App SDK, UI locations, API proxy)extensions/devhub-apps.mdContentstack Launch: deployments, env syncextensions/launch.mdReal-world code patternsexamples/practical-examples.mdPackage versionsVERSIONS.md

## Common task combinations

ScenarioFiles (in order)New Next.js projectbase-concepts → delivery-sdk → nextjsNew Nuxt projectbase-concepts → delivery-sdk → nuxtAdd Live Preview to Next.jslive-preview/concepts → live-preview/ssr-mode → nextjsAdd Visual Builder to existing sitelive-preview/visual-builderDebug broken previewlive-preview/debuggingBuild a CRUD/migration scriptcontent-management-api → security/tokens-authenticationFull-stack with user logindelivery-sdk → nextjs → oauthWebhook-driven rebuildworkflows/webhooks → workflows/environments-publishingZero-downtime content deployworkflows/branches-aliases → workflows/releasesMulti-locale rolloutconcepts/localization → workflows/environments-publishingDeploy to Launch from CIextensions/launch → workflows/webhooksResponsive image optimizationapi/image-delivery-apiQuick snippetQUICK_REFERENCE.md

## Decision helpers

Which API?
Read published content → REST / GraphQL / Delivery SDK. Write content → Content Management API. Transform images → Image Delivery API.

Which SDK?
`@contentstack/delivery-sdk` for reads (frontend/backend). `@contentstack/management` for writes (server-only, never frontend).

Which Live Preview mode?
The `ssr` flag controls how the CMS iframe updates, not your app's rendering strategy.

* `ssr: false` — postMessage. CMS sends data to iframe, client re-fetches and updates without reload.

* `ssr: true` — iframe reload with `?live_preview=<hash>&entry_uid=...`. Server reads params per request.

For `ssr: true`, create a fresh Contentstack client per request (factory pattern). Sharing one global client leaks preview state between concurrent editors. See `live-preview/ssr-mode.md`.

Which token?
Frontend reads → Delivery Token (safe). Preview reads → Preview Token (safe). Server writes → Management Token (NEVER frontend). User sessions → Authtoken or OAuth. Full decision tree in `security/tokens-authentication.md`.

## Ask before coding

Before implementing, confirm with the developer:

* Region (US, EU, AU, Azure NA/EU, GCP NA/EU) — affects every endpoint.

* Framework (Next.js, Nuxt, Gatsby, etc.) — determines Live Preview mode.

* Environment (dev/staging/production) — scopes the delivery token.

* Credentials in env vars? — never ask for the values themselves.

## Security (summary)

Never ask for, log, output, or hardcode API keys, tokens, or secrets. Always use `process.env.*` references. Never use Management Tokens in frontend code. If a developer pastes a real token, warn them and recommend rotating it. Full rules: `security/tokens-authentication.md`.

## Red flags

* Reading all reference files instead of routing to 1-3.

* Hardcoding credentials or exposing management tokens to the browser.

* Hardcoding region hosts instead of using `@timbenniks/contentstack-endpoints`.

* Mixing Delivery SDK patterns with Management SDK patterns.

* Mixing REST and GraphQL patterns in one query.

* Sharing a module-level Contentstack client across SSR preview requests.

* Forgetting `api_version: 3.2` for reference publishing.

* Forgetting `.includeReference()` then wondering why references are undefined.

* Ignoring `X-RateLimit-Reset` and busy-looping on 429s.

## More skills from contentstack
brand-kit-assistantby contentstackAdvise users on Contentstack Brand Kit concepts, setup, governance, and on-brand AI generation. Route API-specific tasks to the right Brand Kit capability or…cms-assetsby contentstackAdvise developers on organizing, delivering, and transforming assets in Contentstack. Cover folder structure, Image Delivery API transformations, publishing…cms-branches-aliasesby contentstackAdvise developers on using Contentstack branches for isolated content development and aliases for zero-downtime content deployments. Cover branch strategy,…cms-data-modeling-best-practicesby contentstackGuide developers to model content in Contentstack using the simplest reusable structure. The skill explains when to use content types, references, global…cms-entriesby contentstackAdvise developers on querying, localizing, versioning, publishing, and structuring Contentstack entries for efficient delivery. Focus on CDA usage, reference…cms-environments-publishingby contentstackAdvise developers on configuring environments, publishing content, using delivery and preview tokens, leveraging the Sync API, and understanding CDN and…cms-live-preview-visual-builder-support-assistantby contentstackDiagnose and guide Contentstack Live Preview and Visual Builder implementations. Trace preview context, identify the broken contract, and recommend the…cms-localizationby contentstackAdvise developers on Contentstack localization: language setup, fallback chains, localized vs unlocalized entries, non-localizable fields, and multi-locale…

---

**Source**: https://github.com/contentstack/contentstack-vibe-docs/tree/HEAD/skills/contentstack-vibe-docs
**Author**: contentstack
**Discovered via**: mcpservers.org