How to integrate Contentful MCP with Pydantic AI

This guide walks you through connecting Contentful to Pydantic AI using the Composio tool router. By the end, you'll have a working Contentful agent that can list all contentful spaces i manage, get details for the 'marketing' space, update the name of your blog space through natural language commands. This guide will help you understand how to give your Pydantic AI agent real control over a Contentful account through Composio's Contentful MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Get started for freeGet a demo
Contentful logoContentful
Oauth2Api Key

Contentful is a headless CMS for creating, managing, and distributing content via API. It's built for flexibility, letting teams publish anywhere from websites to apps with speed and consistency.

106 Tools

Introduction

This guide walks you through connecting Contentful to Pydantic AI using the Composio tool router. By the end, you'll have a working Contentful agent that can list all contentful spaces i manage, get details for the 'marketing' space, update the name of your blog space through natural language commands.

This guide will help you understand how to give your Pydantic AI agent real control over a Contentful account through Composio's Contentful MCP server.

Before we dive in, let's take a quick look at the key ideas and tools involved.

Also integrate Contentful with

OpenAI Agents SDKClaude Agent SDKClaude CodeClaude CoworkCodexOpenClawHermesCLIGoogle ADKLangChainVercel AI SDKMastra AILlamaIndexCrewAI

TL;DR

Here's what you'll learn:
  • How to set up your Composio API key and User ID
  • How to create a Composio Tool Router session for Contentful
  • How to attach an MCP Server to a Pydantic AI agent
  • How to stream responses and maintain chat history
  • How to build a simple REPL-style chat interface to test your Contentful workflows

What is Pydantic AI?

Pydantic AI is a Python framework for building AI agents with strong typing and validation. It leverages Pydantic's data validation capabilities to create robust, type-safe AI applications.

Key features include:

  • Type Safety: Built on Pydantic for automatic data validation
  • MCP Support: Native support for Model Context Protocol servers
  • Streaming: Built-in support for streaming responses
  • Async First: Designed for async/await patterns

What is the Contentful MCP server, and what's possible with it?

The Contentful MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Contentful account. It provides structured and secure access to your Contentful spaces, so your agent can perform actions like listing spaces, retrieving space details, and updating space information on your behalf.

  • List all available spaces: Quickly fetch a comprehensive list of all Contentful spaces you have access to, making it easier to choose where to manage or publish content.
  • Retrieve detailed space information: Ask your agent to pull up full details about any specific Contentful space, including metadata and configuration—great for audits or content planning.
  • Update space names safely: Let your agent rename a space by handling version checks and updates for you, ensuring your workspace stays organized and accurately labeled.
  • Streamline space management: Automate repetitive space-related tasks, like checking which spaces are available or updating their names, so you can focus on content creation.

What is the Composio tool router, and how does it fit here?

What is Composio SDK?

Composio's Composio SDK helps agents find the right tools for a task at runtime. You can plug in multiple toolkits (like Gmail, HubSpot, and GitHub), and the agent will identify the relevant app and action to complete multi-step workflows. This can reduce token usage and improve the reliability of tool calls. Read more here: Getting started with Composio SDK

The tool router generates a secure MCP URL that your agents can access to perform actions.

How the Composio SDK works

The Composio SDK follows a three-phase workflow:

  1. Discovery: Searches for tools matching your task and returns relevant toolkits with their details.
  2. Authentication: Checks for active connections. If missing, creates an auth config and returns a connection URL via Auth Link.
  3. Execution: Executes the action using the authenticated connection.

Step-by-step Guide

Step by step09 STEPS
1

Prerequisites

Before starting, make sure you have:
  • Python 3.9 or higher
  • A Composio account with an active API key
  • Basic familiarity with Python and async programming
2

Getting API Keys for OpenAI and Composio

OpenAI API Key
  • Go to the OpenAI dashboard and create an API key. You'll need credits to use the models, or you can connect to another model provider.
  • Keep the API key safe.
Composio API Key
  • Log in to the Composio dashboard.
  • Navigate to your API settings and generate a new API key.
  • Store this key securely as you'll need it for authentication.
3

Install dependencies

bash
pip install composio pydantic-ai python-dotenv

Install the required libraries.

What's happening:

  • composio connects your agent to external SaaS tools like Contentful
  • pydantic-ai lets you create structured AI agents with tool support
  • python-dotenv loads your environment variables securely from a .env file
4

Set up environment variables

bash
COMPOSIO_API_KEY=your_composio_api_key_here
USER_ID=your_user_id_here
OPENAI_API_KEY=your_openai_api_key

Create a .env file in your project root.

What's happening:

  • COMPOSIO_API_KEY authenticates your agent to Composio's API
  • USER_ID associates your session with your account for secure tool access
  • OPENAI_API_KEY to access OpenAI LLMs
5

Import dependencies

python
import asyncio
import os
from dotenv import load_dotenv
from composio import Composio
from pydantic_ai import Agent
from pydantic_ai.mcp import MCPServerStreamableHTTP

load_dotenv()
What's happening:
  • We load environment variables and import required modules
  • Composio manages connections to Contentful
  • MCPServerStreamableHTTP connects to the Contentful MCP server endpoint
  • Agent from Pydantic AI lets you define and run the AI assistant
6

Create a Tool Router Session

python
async def main():
    api_key = os.getenv("COMPOSIO_API_KEY")
    user_id = os.getenv("USER_ID")
    if not api_key or not user_id:
        raise RuntimeError("Set COMPOSIO_API_KEY and USER_ID in your environment")

    # Create a Composio Tool Router session for Contentful
    composio = Composio(api_key=api_key)
    session = composio.create(
        user_id=user_id,
        toolkits=["contentful"],
    )
    url = session.mcp.url
    if not url:
        raise ValueError("Composio session did not return an MCP URL")
What's happening:
  • We're creating a Tool Router session that gives your agent access to Contentful tools
  • The create method takes the user ID and specifies which toolkits should be available
  • The returned session.mcp.url is the MCP server URL that your agent will use
7

Initialize the Pydantic AI Agent

python
# Attach the MCP server to a Pydantic AI Agent
contentful_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY})
agent = Agent(
    "openai:gpt-5",
    toolsets=[contentful_mcp],
    instructions=(
        "You are a Contentful assistant. Use Contentful tools to help users "
        "with their requests. Ask clarifying questions when needed."
    ),
)
What's happening:
  • The MCP client connects to the Contentful endpoint
  • The agent uses GPT-5 to interpret user commands and perform Contentful operations
  • The instructions field defines the agent's role and behavior
8

Build the chat interface

python
# Simple REPL with message history
history = []
print("Chat started! Type 'exit' or 'quit' to end.\n")
print("Try asking the agent to help you with Contentful.\n")

while True:
    user_input = input("You: ").strip()
    if user_input.lower() in {"exit", "quit", "bye"}:
        print("\nGoodbye!")
        break
    if not user_input:
        continue

    print("\nAgent is thinking...\n", flush=True)

    async with agent.run_stream(user_input, message_history=history) as stream_result:
        collected_text = ""
        async for chunk in stream_result.stream_output():
            text_piece = None
            if isinstance(chunk, str):
                text_piece = chunk
            elif hasattr(chunk, "delta") and isinstance(chunk.delta, str):
                text_piece = chunk.delta
            elif hasattr(chunk, "text"):
                text_piece = chunk.text
            if text_piece:
                collected_text += text_piece
        result = stream_result

    print(f"Agent: {collected_text}\n")
    history = result.all_messages()
What's happening:
  • The agent reads input from the terminal and streams its response
  • Contentful API calls happen automatically under the hood
  • The model keeps conversation history to maintain context across turns
9

Run the application

python
if __name__ == "__main__":
    asyncio.run(main())
What's happening:
  • The asyncio loop launches the agent and keeps it running until you exit

Complete Code

Here's the complete code to get you started with Contentful and Pydantic AI:

python
import asyncio
import os
from dotenv import load_dotenv
from composio import Composio
from pydantic_ai import Agent
from pydantic_ai.mcp import MCPServerStreamableHTTP

load_dotenv()

async def main():
    api_key = os.getenv("COMPOSIO_API_KEY")
    user_id = os.getenv("USER_ID")
    if not api_key or not user_id:
        raise RuntimeError("Set COMPOSIO_API_KEY and USER_ID in your environment")

    # Create a Composio Tool Router session for Contentful
    composio = Composio(api_key=api_key)
    session = composio.create(
        user_id=user_id,
        toolkits=["contentful"],
    )
    url = session.mcp.url
    if not url:
        raise ValueError("Composio session did not return an MCP URL")

    # Attach the MCP server to a Pydantic AI Agent
    contentful_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY})
    agent = Agent(
        "openai:gpt-5",
        toolsets=[contentful_mcp],
        instructions=(
            "You are a Contentful assistant. Use Contentful tools to help users "
            "with their requests. Ask clarifying questions when needed."
        ),
    )

    # Simple REPL with message history
    history = []
    print("Chat started! Type 'exit' or 'quit' to end.\n")
    print("Try asking the agent to help you with Contentful.\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "bye"}:
            print("\nGoodbye!")
            break
        if not user_input:
            continue

        print("\nAgent is thinking...\n", flush=True)

        async with agent.run_stream(user_input, message_history=history) as stream_result:
            collected_text = ""
            async for chunk in stream_result.stream_output():
                text_piece = None
                if isinstance(chunk, str):
                    text_piece = chunk
                elif hasattr(chunk, "delta") and isinstance(chunk.delta, str):
                    text_piece = chunk.delta
                elif hasattr(chunk, "text"):
                    text_piece = chunk.text
                if text_piece:
                    collected_text += text_piece
            result = stream_result

        print(f"Agent: {collected_text}\n")
        history = result.all_messages()

if __name__ == "__main__":
    asyncio.run(main())

Conclusion

You've built a Pydantic AI agent that can interact with Contentful through Composio's Tool Router. With this setup, your agent can perform real Contentful actions through natural language. You can extend this further by:
  • Adding other toolkits like Gmail, HubSpot, or Salesforce
  • Building a web-based chat interface around this agent
  • Using multiple MCP endpoints to enable cross-app workflows (for example, Gmail + Contentful for workflow automation)
This architecture makes your AI agent "agent-native", able to securely use APIs in a unified, composable way without custom integrations.
TOOLS

Supported Tools

Every Contentful action and event your agent gets out of the box.

Activate Content Type

Activates (publishes) a content type in Contentful.

Archive Asset

Tool to archive an asset in Contentful.

Archive Entry

Tool to archive an entry in Contentful.

Archive Release

Tool to archive a release in Contentful.

Create App Signing Key

Tool to generate an app signing key for a Contentful app definition.

Create Content Type

Tool to create a new content type in a Contentful environment.

Create Entry Task

Tool to create a task on a Contentful entry.

Create Environment

Tool to create a new environment within a Contentful space.

Create App Access Grant

Creates an access grant for an app definition to allow organizations to install the app.

Create Organizations App Definitions

Tool to create a new app definition in a Contentful organization.

Create App Definition Action

Tool to create an action for a Contentful app definition.

Create Organization Invitation

Create an invitation to an organization in Contentful (alpha feature).

Create Organizations Security Contacts

Creates a security contact for a specific organization.

Create Organizations Taxonomy Concepts

Tool to create a new taxonomy concept in a Contentful organization.

Create Organizations Taxonomy Concept Schemes

Tool to create a new taxonomy concept scheme in an organization.

Create Release

Tool to create a new release in Contentful.

Create Delivery API Key

Tool to create a new Delivery API key for a Contentful space.

Create Asset

Tool to create a new asset in a Contentful space environment.

Create Entry

Tool to create a new entry in a Contentful space environment.

Create Entry Comment

Tool to create a comment on an entry in Contentful.

Create Extension

Tool to create a new UI extension within a Contentful space and environment.

Create Scheduled Action

Tool to create a scheduled action for publishing or unpublishing entries/assets in Contentful.

Delete Asset

Deletes an asset by ID from a Contentful environment.

Delete Content Type

Deletes a content type by ID from a Contentful environment.

Delete Entry

Deletes an entry by ID from a Contentful environment.

Delete Environment

Deletes an environment by ID from a Contentful space.

Delete Extension

Deletes an extension by ID from a Contentful environment.

Delete App Event Subscription

Deletes an app event subscription from a Contentful organization.

Delete App Definition Details

Tool to delete app definition details for an organization in Contentful.

Delete App Key

Tool to delete an app key from an app definition in a Contentful organization.

Delete App Definition Signing Secret

Tool to remove the current app signing secret from an app definition.

Delete Organization Security Contact

Deletes a security contact from a Contentful organization.

Delete Release

Deletes a release by ID from a Contentful environment.

Delete Scheduled Action

Cancels a scheduled action by ID in Contentful.

Delete Space Membership

Deletes a space membership by ID from a Contentful space.

Delete Delivery API Key

Tool to delete a single Delivery API key from a Contentful space.

Delete Spaces Upload

Deletes an upload by ID from a Contentful space.

Delete Tag

Deletes a tag by ID from a Contentful environment.

Get App Bundle

Retrieves details of a specific app bundle by its ID.

Get App Definition

Tool to retrieve details of a specific app definition by its ID.

Get Asset

Tool to retrieve a single asset from a Contentful environment by its ID.

Get Content Types

Retrieves all content types in a Contentful environment.

Get Content Type Snapshot

Tool to retrieve a snapshot of a content type by snapshot ID.

Get Content Type Snapshots

Tool to get all snapshots of a content type in Contentful.

Get Editor Interface

Tool to retrieve the editor interface configuration for a content type.

Get Entry Comment

Tool to retrieve a specific comment from an entry in Contentful.

Get Entry References

Tool to retrieve references to a specific entry in Contentful.

Get Entry Snapshots

Tool to get all snapshots of an entry in Contentful.

Get Environment

Tool to retrieve details of a specific environment by its ID within a space.

Get Organization

Retrieves details of a specific organization by its ID.

Get Organization Access Grant

Retrieves the access grant status for a specific organization.

Get Organizations

Tool to get all organizations an account has access to in Contentful.

Get Organizations AI Providers

Retrieves all AI providers configured for an organization in Contentful.

Get Organization App Actions Categories

Retrieves app action categories for a Contentful organization.

Get App Event Subscription

Tool to retrieve details of an app event subscription by organization and app definition ID.

Get Organizations App Definitions

Retrieves all app definitions for a specific organization.

Get Organizations App Definitions Access Grants

Get all app access grants for a specific app definition within an organization.

Get App Definition Actions

Tool to get all actions of an app definition within an organization.

Get App Action Details

Tool to read a specific app action from an app definition within an organization.

Get App Definition App Bundles

Tool to get all app bundles for a specific app definition within an organization.

Get App Definition Functions

Tool to get all functions of an app definition within an organization.

Get App Definition Keys

Tool to retrieve all app keys for a specific app definition in a Contentful organization.

Get App Definition Signing Secret

Tool to retrieve the current app signing secret for an app definition.

Get Organization Enablements

Retrieves feature enablements for a specific organization in Contentful.

Get Organization Invitation

Retrieves a single invitation for an organization (alpha).

Get Organization Periodic Usages

Tool to get organization periodic usage statistics.

Get Organization Roles

Retrieves all space roles in an organization.

Get Organization Security Contacts

Retrieves security contacts for a specific organization that an admin or owner has access to.

Get Organizations Space Enablements

Retrieves all space enablements for a specific organization.

Get Organizations Space Periodic Usages

Tool to retrieve space periodic usage data for an organization.

Get Organizations Taxonomy Concepts

Retrieves all taxonomy concepts for an organization in Contentful.

Get Taxonomy Concept Ancestors

Retrieves the list of ancestor concepts for a specific taxonomy concept.

Get Organizations Taxonomy Concept Schemes

Tool to retrieve all taxonomy concept schemes from an organization.

Get Taxonomy Concept Scheme

Tool to retrieve a specific taxonomy concept scheme from an organization.

Get Organizations Taxonomy Concept Schemes Total

Retrieves the total count of taxonomy concept schemes for a specific organization.

Get Organizations Taxonomy Concepts Total

Retrieves the total count of taxonomy concepts for a specific organization.

Get Release

Tool to get a single release by ID from Contentful.

Get space

Retrieves metadata of a specific space by its ID.

Get Space Memberships

Tool to get all space memberships in a Contentful space.

Get Delivery API Keys

Tool to retrieve all Delivery API keys for a specific Contentful space.

Get Space Environments

Retrieves all environments of a space in Contentful.

List App Installations

Lists all app installations in a specific Contentful environment.

Get All Assets

Retrieves all assets from a specific environment in a Contentful space.

Get Space Environment Locales

Tool to retrieve all locales of a space environment in Contentful.

Get App Installation Functions

Tool to get all functions for an app installation in a Contentful environment.

Get Authenticated User

Tool to retrieve information about the currently authenticated user.

List Entries

Tool to retrieve all entries from a Contentful space environment.

List spaces

Lists all spaces that the authenticated user has access to in Contentful.

Get All Space Roles

Tool to retrieve all roles from a Contentful space.

Publish Entry

Tool to publish an entry in Contentful, making it available via the Content Delivery API.

Query Asset Collection

Tool to retrieve multiple assets with pagination and filtering via GraphQL API.

Query GraphQL Content Type Collection

Tool to query a collection of entries for a specific content type using GraphQL.

Update App Definition

Tool to update an app definition by ID in a Contentful organization.

Update Editor Interface

Tool to update the editor interface configuration for a content type.

Update Entry

Tool to create or update an entry in a Contentful space environment.

Update App Event Subscription

Tool to update or create an app event subscription in a Contentful organization.

Update App Definition Action

Tool to update an action for a Contentful app definition.

Update App Definition Details

Tool to create or update app definition details for an organization in Contentful.

Update App Definition Signing Secret

Tool to create or overwrite the app signing secret for an app definition.

Update Organization Enablements

Updates feature enablements for a specific organization in Contentful.

Update Organization Security Contact

Updates an organization security contact that an admin or owner has access to.

Update Organizations Taxonomy Concepts

Tool to create or update a taxonomy concept with a user-defined ID in a Contentful organization.

Update Organizations Taxonomy Concept Schemes

Tool to create or update a taxonomy concept scheme with a user-defined ID in an organization.

Update space

Updates the name of a specific space.

Update Tag

Creates or updates a tag in a Contentful environment.

Validate Bulk Action

Tool to validate a bulk action before executing it.

FRAMEWORKS

How to build Contentful MCP Agent with another framework

OpenAI Agents SDK logo

OpenAI Agents SDK

Use Contentful MCP with OpenAI Agents SDK

Claude Agent SDK logo

Claude Agent SDK

Use Contentful MCP with Claude Agent SDK

Claude Code logo

Claude Code

Use Contentful MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use Contentful MCP with Claude Cowork

Codex logo

Codex

Use Contentful MCP with Codex

OpenClaw logo

OpenClaw

Use Contentful MCP with OpenClaw

Hermes logo

Hermes

Use Contentful MCP with Hermes

CLI logo

CLI

Use Contentful MCP with CLI

Google ADK logo

Google ADK

Use Contentful MCP with Google ADK

LangChain logo

LangChain

Use Contentful MCP with LangChain

Vercel AI SDK logo

Vercel AI SDK

Use Contentful MCP with Vercel AI SDK

Mastra AI logo

Mastra AI

Use Contentful MCP with Mastra AI

LlamaIndex logo

LlamaIndex

Use Contentful MCP with LlamaIndex

CrewAI logo

CrewAI

Use Contentful MCP with CrewAI

FAQ

Frequently asked questions

With a standalone Contentful MCP server, the agents and LLMs can only access a fixed set of Contentful tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Contentful and many other apps based on the task at hand, all through a single MCP endpoint.

Yes, you can. Pydantic AI fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Contentful tools.

Yes, absolutely. You can configure which Contentful scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do.

All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Contentful data and credentials are handled as safely as possible.

Start with Contentful.It takes 30 seconds.

Managed auth, hosted MCP servers, and every Contentful tool your agent needs.Free to start.

Start building
Customer stories

Teams ship real agents on Composio

GET STARTED FOR FREEBOOK A DEMO
agent.aiZoomLettaGleanHubSpotAWSWabi

Karan skipped his own birthday party to fix our critical issue. It was 10pm and he diverted his Waymo to help us instead. This really sets the bar — it shows the commitment you need when users rely on your software.

Harsha Gaddipati
Harsha Gaddipati
Co-founder, Slashy

A lot of students tell us that the moment their connected tools start talking to each other inside Opennote feels almost magical. The agent just knows them, and it's immensely helped keep new users on the platform.

Abhi Arya
Abhi Arya
Co-founder, Opennote

We chose Composio over Pipedream because it delivered depth where it mattered — niche tools and tricky edge cases other platforms simply ignored. That gave us confidence to scale without compromising.

Nirman Dave
Nirman Dave
CEO, Zams

As a solo builder, shipping fast is life or death. The only way I can outcompete incumbents is by outmanoeuvring them. Getting bogged down managing agent auth would have been a death sentence.

Ryan Yu
Ryan Yu
Founder, Extra Thursday

Before Composio, adding tool integrations was slow and resource-intensive. Each one could take weeks of engineering time, and maintaining them meant constantly keeping up with API changes.

Tomisin Jenrola
Tomisin Jenrola
Founder & CEO, SwarmZero

With hands-on help from their founder, we integrated Gmail and Google Drive in just 30 minutes. This level of personal support and commitment is exactly what startups should strive for.

Jerome Leclanche
Jerome Leclanche
Co-Founder, Ingram Technologies