Skip to content

contentful/skills

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

230 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Contentful



Your AI agent knows how to code. These skills teach it Contentful.


version license skills platforms


AI coding agents write great code but know nothing about your content model, your SDK patterns, or which of Contentful's five APIs to reach for. Contentful Skills fixes that — curated instructions, reference docs, and structured workflows that produce correct Contentful integrations on the first try.

Quickstart — Claude Code

Two commands. You get four skills plus live MCP connections to your Contentful spaces.

/plugin marketplace add contentful/skills
/plugin install contentful-skills@contentful

Run /reload-plugins to activate. This registers two MCP servers:

  • contentful-mcp — connection to mcp.contentful.com for CMS operations
  • contentful-personalization — local MCP for structured personalization workflows

What's inside

Skill What it does
contentful-guide Explains core concepts and routes you to the right skill, API, or doc. Start here.
contentful-nextjs Integrates Contentful into a Next.js project — SDK setup, content fetching, Draft Mode previews.
contentful-migration Writes and runs content model migration scripts — fields, validations, transforms, editor interfaces.
contentful-personalization Sets up, debugs, and develops personalization and A/B testing with the Experiences SDK.

Other platforms

Skills also work without the plugin on any platform that supports the agentskills.io spec.

Cursor

  1. Open SettingsRules
  2. Click Add RuleRemote Rule (GitHub)
  3. Enter contentful/skills

Universal CLI

npx skills add contentful/skills

Works with GitHub Copilot, VS Code, OpenAI Codex, Gemini CLI, and 35+ other platforms.

More options

Gemini CLI:

gemini skills install contentful/skills

GitHub Copilot / VS Code:

Skills auto-discover from .agents/skills/ when added to your project. Use /skills in Copilot Chat to confirm they're loaded.

Install a single skill:

npx skills add contentful/skills --skill contentful-personalization

Available: contentful-guide, contentful-nextjs, contentful-migration, contentful-personalization


Skills

contentful-guide

Explains core Contentful concepts and routes you to the right skill or documentation. Start here if you're new to Contentful or unsure which API to use.

Triggers and details

Activates on: "Contentful 101", "which API should I use", "how do I get started", "what does X mean in Contentful"

Covers:

  • Core vocabulary — spaces, environments, content types, entries, assets, locales
  • API selection — CDA vs CPA vs CMA vs GraphQL vs Images API
  • Routing to the right implementation skill
  • Contentful MCP server orientation

contentful-nextjs

Add and configure Contentful in a Next.js project. Covers SDK setup, environment variables, content fetching, and Draft Mode preview flows for both App Router and Pages Router.

Triggers and details

Activates on: "add Contentful to Next.js", "Contentful SDK setup", "Draft Mode", "preview mode", "Server Components Contentful"

Covers:

  • SDK installation and client configuration
  • Environment variables and environment aliases
  • Content fetching patterns (App Router and Pages Router)
  • Draft Mode preview flows with CPA
  • ISR (Incremental Static Regeneration) setup
  • Troubleshooting common integration issues

contentful-migration

Write and run content model migration scripts using the Contentful migration library. Covers field operations, validations, entry transforms, and editor interface configuration.

Triggers and details

Activates on: "write a migration", "create content type", "schema migration", "field validation", "editor interface", "changeFieldId"

Covers:

  • Content type creation, editing, and deletion
  • Field operations — add, rename, move, change type
  • Validations — range, regex, linked content types, asset file constraints
  • Entry transforms — in-place edits, deriving linked entries, moving entries between types
  • Editor interface wiring — widgets, field layout, sidebar controls
  • Best practices — sandbox testing, sequential file naming, separating schema from data changes

contentful-personalization

Set up, debug, and develop with Contentful personalization and A/B testing. A structured, multi-step skill with three workflows and a reference library of 19+ documents.

Workflows and details

Activates on: "set up personalization", "A/B test", "personalization not working", "Experiences SDK", "run an experiment", "audience targeting"

Workflows:

  • Onboard — Assess readiness, select SDK, guided installation, content type setup
  • Doctor — Diagnose broken setups: checks packages, env vars, API connectivity, content state
  • Develop — Day-to-day companion for personalizing components, running experiments, wiring analytics

Reference library: SDK guides, component patterns, SSR/middleware patterns, provider patterns, analytics setup, environment variables, error resolution, and more.

Built with @contentful/skill-kit — a structured state machine with MCP server integration.


MCP Server Setup

Plugin installs configure MCP connections automatically. If you installed via npx skills add or another non-plugin path, set up the MCP servers manually to get the full experience.

Contentful MCP (CMS operations)

Connects your agent to your Contentful spaces for reading and writing content, content types, and assets.

Claude Code:

/mcp add-http contentful-mcp https://mcp.contentful.com/mcp

Other platforms — add to your MCP config:

{
  "mcpServers": {
    "contentful-mcp": {
      "type": "http",
      "url": "https://mcp.contentful.com/mcp"
    }
  }
}

Personalization MCP (structured workflows)

The contentful-personalization skill includes a local MCP server that powers its interactive workflows. Point your agent at the skill's run script:

Claude Code:

/mcp add -- /path/to/skills/contentful-personalization/scripts/run mcp --host claude-code

Other platforms — add to your MCP config:

{
  "mcpServers": {
    "contentful-personalization": {
      "command": "/path/to/skills/contentful-personalization/scripts/run",
      "args": ["mcp", "--host", "claude-code"]
    }
  }
}

Note

Replace /path/to/skills/ with the actual path where skills were installed (typically .agents/skills/ in your project).


Local Plugin Testing (Claude Code)

To test the full plugin locally — including skills, MCP servers, and hooks — without publishing:

claude --plugin-dir /path/to/contentful/skills

This loads everything defined in .claude-plugin/plugin.json for that session: skills, the Contentful MCP server, and the personalization MCP server. Use /reload-plugins inside the session to pick up changes without restarting.

You can also combine multiple plugin directories:

claude --plugin-dir ./skills --plugin-dir ./other-plugin

Contributing

See CONTRIBUTING.md for development setup and guidelines. We welcome bug reports, feature requests, and pull requests.

Help and Support

Contributors

François
François

💻
Tim Beyer
Tim Beyer

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT — see LICENSE for details.

About

Skills for teaching agents how to build on Contentful.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Contributors