Skip to main content
skill CX Codex

contentful-guide — Claude Code skill: Contentful terms and API choice

Explains Contentful concepts and points you to the right API for the job. Handy when a project is new to headless CMS work.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add contentful/skills --skill contentful-guide -a claude-code
Open on GitHub

What contentful-guide does

The skill acts as a vocabulary and routing layer. It defines space, environment, environment alias, content model, content type, entry, asset and locale, then maps the task to an API: CDA for published delivery content, CPA for previews, CMA for writes, GraphQL Content API when you want control over query shape, Images API for image transformations.

Three references back it up: references/lexicon.md for shared terms, references/docs-map.md for doc paths, references/skill-routing.md for handoffs. Ask for Next.js code, content type migrations, personalization or concrete REST/GraphQL requests and it will not write the implementation itself — it hands off to contentful-nextjs, contentful-migration, contentful-personalization or contentful-api. So don't expect framework-specific examples here.

There is a section on the Contentful MCP server too, for when an agent needs conversational access to spaces, entries and content model context without SDK code. The skill declares mcp__contentful-mcp__* and mcp__plugin_contentful_contentful-mcp__* tools, so that part does nothing until the MCP server is configured. You can pass an argument up front: [concept or API name].

What it helps with

  • tell CDA apart from CPA and GraphQL
  • pick an API for reading, previewing or writing content
  • explain environments and aliases to a team
  • decide when the Contentful MCP server is worth setting up
  • route a task to the specialized skill instead of a general answer

Example prompts for the agent

  • Explain what an environment alias is in Contentful and how to use it at deploy time
  • Which API should I use to preview unpublished entries?
  • Help me set up the Contentful MCP server to work with entries

How to install contentful-guide

1Skills CLI (Vercel)

npx skills add contentful/skills --skill contentful-guide -a claude-code

2Manually: put the files in place

~/.claude/skills/contentful-guide/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/contentful-guide/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about contentful-guide

How do I install contentful-guide in Claude?

Run npx skills add contentful/skills --skill contentful-guide -a claude-code. The skill file lands at ~/.claude/skills/contentful-guide/SKILL.md.

What does contentful-guide do?

It explains core Contentful terms, helps you choose between CDA, CPA, CMA, GraphQL and Images API, and routes implementation requests to the right skill or docs path.

How is contentful-guide different from contentful-api?

This skill handles conceptual questions and routing. For concrete REST and GraphQL requests with headers and query parameters, it sends you to contentful-api.

Source text

SKILL.md · MIT
---
name: contentful-guide
description: >-
  Explain core Contentful concepts and route users to the right implementation
  skill or documentation. Use when users ask conceptual questions, need
  terminology clarified, want help choosing between APIs (CDA/CMA/CPA/GraphQL),
  or need guidance on the Contentful MCP server. Also triggers on "Contentful
  101", "which Contentful API", "how do I get started", "which skill should I
  use", "what does X mean in Contentful", "Contentful glossary", "CDA vs CPA",
  "CDA vs GraphQL", "how does Contentful work", "Contentful architecture",
  "explain environments", "what are aliases", "content model design",
  "headless CMS", "Contentful MCP", "MCP server", "set up MCP",
  "Remix Contentful", "Astro Contentful", "Gatsby Contentful",
  "SvelteKit Contentful", "Nuxt Contentful". Not for framework-specific
  implementation (contentful-nextjs), migrations (contentful-migration),
  personalization (contentful-personalization), or hands-on REST/GraphQL
  request examples (contentful-api).
argument-hint: "[concept or API name]"
allowed-tools: mcp__contentful-mcp__* mcp__plugin_contentful_contentful-mcp__*
---

# Contentful Guide

Use this skill as the routing and vocabulary layer for Contentful tasks.

Contentful is a headless, API-first CMS (composable content platform) where teams model content once and deliver it to many channels.

## What this skill does

1. Clarifies core terms (space, environment, environment alias, content model, content type, entry, asset, locale).
2. Maps user intent to the right API (CDA, CPA, CMA, GraphQL, Images API).
3. Routes implementation requests to the right skill and docs.
4. Prevents incorrect setup by identifying when a request is not in this skill's scope.

## Routing rules

- If the user asks to add Contentful to a Next.js project, use the contentful-nextjs skill.
- If the user asks about optimization/personalization/analytics setup or debugging, route to the `contentful-personalization` skill.
- If the user asks to write content type migrations or schema changes, route to the `contentful-migration` skill.
- If the user asks for concrete REST/GraphQL requests (curl examples, headers, query parameters, payload shapes for CMA/CDA/CPA/Images/GraphQL), route to the `contentful-api` skill.
- If the user asks for conceptual guidance, architecture tradeoffs, or where to read docs, stay in this skill.
- If the user asks about environment aliases and deployment workflows, stay in this skill unless they also ask for framework implementation.

## API chooser

- Use **CDA** for published delivery content in websites/apps.
- Use **CPA** for unpublished preview content.
- Use **CMA** for write operations (create/update/manage content and models).
- Use **GraphQL Content API** when query shape control is preferred over REST payloads.
- Use **Images API** for image transformations.

## Contentful MCP note

- The Contentful MCP server is often the easiest way to let an agent interact with Contentful.
- Use it when the user wants conversational access to spaces, entries, and content model context without wiring SDK code first.
- Canonical docs: `https://www.contentful.com/developers/docs/tools/mcp-server/`

## Operating pattern

When answering with this skill:

1. Define terms using shared vocabulary from `references/lexicon.md`.
2. Pick the right docs path from `references/docs-map.md`.
3. If implementation is requested, hand off using `references/skill-routing.md`.
4. Keep answers concise and cite canonical docs paths.

## Guardrails

- Do not invent product capabilities, API behavior, or limits.
- Do not provide framework code unless routing to the specialized implementation skill.
- Prefer official docs over memory when details may be version-sensitive.

## References

- [Lexicon](references/lexicon.md)
- [Docs map](references/docs-map.md)
- [Skill routing](references/skill-routing.md)

© contentful · MIT · contentful/skills

Similar skills

All skills for Agent setup: memory, context, orchestration →

From the same set5

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor