Skip to content

Latest commit

 

History

History
203 lines (146 loc) · 7.78 KB

README.md

File metadata and controls

203 lines (146 loc) · 7.78 KB

Contentful MCP Server

smithery badge

An MCP server implementation that integrates with Contentful's Content Management API, providing comprehensive content management capabilities.

  • Please note *; if you are not interested in the code, and just want to use this MCP in Claude Desktop (or any other tool that is able to use MCP servers) you don't have to clone this repo, you can just set it up in Claude desktop, refer to the section "Usage with Claude Desktop" for instructions on how to install it.

contentful-mcp MCP server

Features

  • Content Management: Full CRUD operations for entries and assets
  • Space Management: Create, update, and manage spaces and environments
  • Content Types: Manage content type definitions
  • Localization: Support for multiple locales
  • Publishing: Control content publishing workflow
  • Smart Pagination: List operations return maximum 3 items per request to prevent context window overflow, with built-in pagination support

Pagination

To prevent context window overflow in LLMs, list operations (like search_entries and list_assets) are limited to 3 items per request. Each response includes:

  • Total number of available items
  • Current page of items (max 3)
  • Number of remaining items
  • Skip value for the next page
  • Message prompting the LLM to offer retrieving more items

This pagination system allows the LLM to efficiently handle large datasets while maintaining context window limits.

Tools

Entry Management

  • search_entries: Search for entries using query parameters
  • create_entry: Create new entries
  • get_entry: Retrieve existing entries
  • update_entry: Update entry fields
  • delete_entry: Remove entries
  • publish_entry: Publish entries
  • unpublish_entry: Unpublish entries

Asset Management

  • list_assets: List assets with pagination (3 items per page)
  • upload_asset: Upload new assets with metadata
  • get_asset: Retrieve asset details and information
  • update_asset: Update asset metadata and files
  • delete_asset: Remove assets from space
  • publish_asset: Publish assets to delivery API
  • unpublish_asset: Unpublish assets from delivery API

Space & Environment Management

  • list_spaces: List available spaces
  • get_space: Get space details
  • list_environments: List environments in a space
  • create_environment: Create new environment
  • delete_environment: Remove environment

Content Type Management

  • list_content_types: List available content types
  • get_content_type: Get content type details
  • create_content_type: Create new content type
  • update_content_type: Update content type
  • delete_content_type: Remove content type
  • publish_content_type: Publish a content type

Development Tools

MCP Inspector

The project includes an MCP Inspector tool that helps with development and debugging:

  • Inspect Mode: Run npm run inspect to start the inspector, you can open the inspector by going to http://localhost:5173
  • Watch Mode: Use npm run inspect:watch to automatically restart the inspector when files change
  • Visual Interface: The inspector provides a web interface to test and debug MCP tools
  • Real-time Testing: Try out tools and see their responses immediately

The project also contains a npm run dev command which rebuilds and reloads the MCP server on every change.

Configuration

Prerequisites

  1. Create a Contentful account at Contentful
  2. Generate a Content Management API token from your account settings

Environment Variables

These variables can also be set as arguments

  • CONTENTFUL_HOST / --host: Contentful Management API Endpoint (defaults to https://api.contentful.com)
  • CONTENTFUL_MANAGEMENT_ACCESS_TOKEN / --management-token: Your Content Management API token

Space and Environment Scoping (EXPERIMENTAL)

You can scope the spaceId and EnvironmentId to ensure the LLM will only do operations on the defined space/env ID's. This is mainly to support agents that are to operate within specific spaces. If both SPACE_ID and ENVIRONMENT_ID env-vars are set the tools will not report needing these values and the handlers will use the environment vars to do CMA operations. You will also loose access to the tools in the space-handler, since these tools are across spaces. You can also add the SPACE_ID and ENVIRONMENT_ID by using arguments --space-id and --environment-id

Using App Identity

Instead of providing a Management token you can also leverage App Identity for handling authentication. You would have to setup and install a Contentful App and set the following parameters when calling the MCP-server:

  • --app-id = the app Id which is providing the Apptoken
  • --private-key = the private key you created in the user-interface with your app, tied to app_id
  • --space-id = the spaceId in which the app is installed
  • --environment-id = the environmentId (within the space) in which the app is installed.

With these values the MCP server will request a temporary AppToken to do content operation in the defined space/environment-id. This especially useful when using this MCP server in backend systems that act as MCP-client (like chat-agents)

Usage with Claude Desktop

You do not need to clone this repo to use this MCP, you can simply add it to your claude_desktop_config.json:

Add or edit ~/Library/Application Support/Claude/claude_desktop_config.json and add the following lines:

{
  "mcpServers": {
    "contentful": {
      "command": "npx",
      "args": ["-y", "@ivotoby/contentful-management-mcp-server"],
      "env": {
        "CONTENTFUL_MANAGEMENT_ACCESS_TOKEN": "<Your CMA token>"
      }
    }
  }
}

If your MCPClient does not support setting environment variables you can also set the management token using an argument like this:

{
  "mcpServers": {
    "contentful": {
      "command": "npx",
      "args": ["-y", "@ivotoby/contentful-management-mcp-server",'--management-token', "<your token>", '--host', 'http://api.contentful.com'],
    }
  }
}

Installing via Smithery

To install Contentful Management Server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @ivotoby/contentful-management-mcp-server --client claude

Developing and using Claude desktop

If you want to contribute and test what Claude does with your contributions;

  • run npm run dev, this will start the watcher that rebuilds the MCP server on every change
  • update claude_desktop_config.json to reference the project directly, ie;
{
  "mcpServers": {
    "contentful": {
      "command": "node",
      "args": ["/Users/ivo/workspace/contentful-mcp/bin/mcp-server.js"],
      "env": {
        "CONTENTFUL_MANAGEMENT_ACCESS_TOKEN": "<Your CMA Token>"
      }
    }
  }
}

This will allow you to test any modification in the MCP server with Claude directly, however; if you add new tools/resources you will need to restart Claude Desktop

Error Handling

The server implements comprehensive error handling for:

  • Authentication failures
  • Rate limiting
  • Invalid requests
  • Network issues
  • API-specific errors

License

MIT License

Fine print

This MCP Server enables Claude (or other agents that can consume MCP resources) to update, delete content, spaces and content-models. So be sure what you allow Claude to do with your Contentful spaces!