# How to integrate Contentful graphql MCP with Pydantic AI

```json
{
  "title": "How to integrate Contentful graphql MCP with Pydantic AI",
  "toolkit": "Contentful graphql",
  "toolkit_slug": "contentful_graphql",
  "framework": "Pydantic AI",
  "framework_slug": "pydantic-ai",
  "url": "https://composio.dev/toolkits/contentful_graphql/framework/pydantic-ai",
  "markdown_url": "https://composio.dev/toolkits/contentful_graphql/framework/pydantic-ai.md",
  "updated_at": "2026-05-12T10:07:26.380Z"
}
```

## Introduction

This guide walks you through connecting Contentful graphql to Pydantic AI using the Composio tool router. By the end, you'll have a working Contentful graphql agent that can fetch latest blog posts from marketing space, get all published product descriptions, query upcoming events for homepage display through natural language commands.
This guide will help you understand how to give your Pydantic AI agent real control over a Contentful graphql account through Composio's Contentful graphql MCP server.
Before we dive in, let's take a quick look at the key ideas and tools involved.

## Also integrate Contentful graphql with

- [OpenAI Agents SDK](https://composio.dev/toolkits/contentful_graphql/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/contentful_graphql/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/contentful_graphql/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/contentful_graphql/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/contentful_graphql/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/contentful_graphql/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/contentful_graphql/framework/hermes-agent)
- [CLI](https://composio.dev/toolkits/contentful_graphql/framework/cli)
- [Google ADK](https://composio.dev/toolkits/contentful_graphql/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/contentful_graphql/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/contentful_graphql/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/contentful_graphql/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/contentful_graphql/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/contentful_graphql/framework/crew-ai)

## 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 graphql
- 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 graphql 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 graphql MCP server, and what's possible with it?

The Contentful graphql 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 content repositories, so your agent can fetch entries, run custom GraphQL queries, retrieve persisted queries, and manage API tokens on your behalf.
- Dynamic content fetching via GraphQL: Let your agent query and retrieve content from any Contentful space and environment using flexible GraphQL queries tailored to your needs.
- Run persisted GraphQL queries: Efficiently execute pre-registered, cached GraphQL queries by hash for faster and more consistent content access.
- On-demand token management: Automatically request and handle Contentful Management API (CMA) tokens so your agent stays authorized for secure operations.
- Custom data retrieval and filtering: Pull structured data, filter content collections, and assemble exactly the information you want from your Contentful instance.

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `CONTENTFUL_GRAPHQL_GET_CMA_TOKEN` | Get CMA Token | Tool to retrieve a Contentful Management API (CMA) access token. Use when making CMA calls to ensure valid authorization. |
| `CONTENTFUL_GRAPHQL_GRAPH_QL_CONTENT_API_PERSISTED_QUERY` | GraphQL Content API Persisted Query | Execute a GraphQL query using Automatic Persisted Queries (APQ). APQ reduces bandwidth by sending only a SHA256 hash instead of the full query text after initial registration. Workflow: 1. First request: Include both sha256_hash and query text to register the query 2. Subsequent requests: Send only sha256_hash and variables - the server uses the cached query Common errors: - PersistedQueryNotFound: Query not cached; include the full query text - PersistedQueryMismatch: Hash doesn't match query text; recompute the hash - UNKNOWN_SPACE: Invalid space_id or access_token for the space |

## Supported Triggers

None listed.

## Creating MCP Server - Stand-alone vs Composio SDK

The Contentful graphql MCP server is an implementation of the Model Context Protocol that connects your AI agent to Contentful graphql. It provides structured and secure access so your agent can perform Contentful graphql operations on your behalf through a secure, permission-based interface.
With Composio's managed implementation, you don't have to create your own developer app. For production, if you're building an end product, we recommend using your own credentials. The managed server helps you prototype fast and go from 0-1 faster.

## Step-by-step Guide

### 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

### 1. Getting API Keys for OpenAI and Composio

OpenAI API Key
- Go to the [OpenAI dashboard](https://platform.openai.com/settings/organization/api-keys) 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](https://dashboard.composio.dev?utm_source=toolkits&utm_medium=framework_docs).
- Navigate to your API settings and generate a new API key.
- Store this key securely as you'll need it for authentication.

### 2. Install dependencies

Install the required libraries.
What's happening:
- composio connects your agent to external SaaS tools like Contentful graphql
- pydantic-ai lets you create structured AI agents with tool support
- python-dotenv loads your environment variables securely from a .env file
```bash
pip install composio pydantic-ai python-dotenv
```

### 3. Set up environment variables

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
```bash
COMPOSIO_API_KEY=your_composio_api_key_here
USER_ID=your_user_id_here
OPENAI_API_KEY=your_openai_api_key
```

### 4. Import dependencies

What's happening:
- We load environment variables and import required modules
- Composio manages connections to Contentful graphql
- MCPServerStreamableHTTP connects to the Contentful graphql MCP server endpoint
- Agent from Pydantic AI lets you define and run the AI assistant
```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()
```

### 5. Create a Tool Router Session

What's happening:
- We're creating a Tool Router session that gives your agent access to Contentful graphql 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
```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 graphql
    composio = Composio(api_key=api_key)
    session = composio.create(
        user_id=user_id,
        toolkits=["contentful_graphql"],
    )
    url = session.mcp.url
    if not url:
        raise ValueError("Composio session did not return an MCP URL")
```

### 6. Initialize the Pydantic AI Agent

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

### 7. Build the chat interface

What's happening:
- The agent reads input from the terminal and streams its response
- Contentful graphql API calls happen automatically under the hood
- The model keeps conversation history to maintain context across turns
```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 graphql.\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()
```

### 8. Run the application

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

## Complete Code

```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 graphql
    composio = Composio(api_key=api_key)
    session = composio.create(
        user_id=user_id,
        toolkits=["contentful_graphql"],
    )
    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_graphql_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY})
    agent = Agent(
        "openai:gpt-5",
        toolsets=[contentful_graphql_mcp],
        instructions=(
            "You are a Contentful graphql assistant. Use Contentful graphql 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 graphql.\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 graphql through Composio's Tool Router. With this setup, your agent can perform real Contentful graphql 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 graphql for workflow automation)
This architecture makes your AI agent "agent-native", able to securely use APIs in a unified, composable way without custom integrations.

## How to build Contentful graphql MCP Agent with another framework

- [OpenAI Agents SDK](https://composio.dev/toolkits/contentful_graphql/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/contentful_graphql/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/contentful_graphql/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/contentful_graphql/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/contentful_graphql/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/contentful_graphql/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/contentful_graphql/framework/hermes-agent)
- [CLI](https://composio.dev/toolkits/contentful_graphql/framework/cli)
- [Google ADK](https://composio.dev/toolkits/contentful_graphql/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/contentful_graphql/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/contentful_graphql/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/contentful_graphql/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/contentful_graphql/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/contentful_graphql/framework/crew-ai)

## Related Toolkits

- [Google Drive](https://composio.dev/toolkits/googledrive) - Google Drive is a cloud storage platform for uploading, sharing, and collaborating on files. It's perfect for keeping your documents accessible and organized across devices.
- [Google Docs](https://composio.dev/toolkits/googledocs) - Google Docs is a cloud-based word processor that enables document creation and real-time collaboration. Its seamless sharing and version history make team editing and content management a breeze.
- [Google Super](https://composio.dev/toolkits/googlesuper) - Google Super is an all-in-one suite combining Gmail, Drive, Calendar, Sheets, Analytics, and more. It gives you a unified platform to manage your digital life, boosting productivity and organization.
- [Affinda](https://composio.dev/toolkits/affinda) - Affinda is an AI-powered document processing platform that automates data extraction from resumes, invoices, and more. It streamlines document-heavy workflows by turning files into structured, actionable data.
- [Agility cms](https://composio.dev/toolkits/agility_cms) - Agility CMS is a headless content management system for building and managing digital experiences across platforms. It lets teams update content quickly and deliver omnichannel experiences with ease.
- [Algodocs](https://composio.dev/toolkits/algodocs) - Algodocs is an AI-powered platform that automates data extraction from business documents. It delivers fast, secure, and accurate processing without templates or manual training.
- [Api2pdf](https://composio.dev/toolkits/api2pdf) - Api2Pdf is a REST API for generating PDFs from HTML, URLs, and documents using powerful engines like wkhtmltopdf and Headless Chrome. It streamlines document conversion and automation for developers and businesses.
- [Aryn](https://composio.dev/toolkits/aryn) - Aryn is an AI-powered platform for parsing, extracting, and analyzing data from unstructured documents. Use it to automate document processing and unlock actionable insights from your files.
- [Boldsign](https://composio.dev/toolkits/boldsign) - Boldsign is a digital eSignature platform for sending, signing, and tracking documents online. Organizations use it to automate agreements and manage legally binding workflows efficiently.
- [Boloforms](https://composio.dev/toolkits/boloforms) - BoloForms is an eSignature platform built for small businesses, offering unlimited signatures, templates, and forms. It simplifies digital document signing and team collaboration at a predictable, fixed price.
- [Box](https://composio.dev/toolkits/box) - Box is a cloud content management and file sharing platform for businesses. It helps teams securely store, organize, and collaborate on files from anywhere.
- [Carbone](https://composio.dev/toolkits/carbone) - Carbone is a blazing-fast report generator that turns JSON data into PDFs, Word docs, spreadsheets, and more using flexible templates. It lets you automate document creation at scale with minimal code.
- [Castingwords](https://composio.dev/toolkits/castingwords) - CastingWords is a transcription service specializing in human-powered, accurate transcripts via a simple API. Get seamless audio-to-text conversion for interviews, meetings, podcasts, and more.
- [Cloudconvert](https://composio.dev/toolkits/cloudconvert) - CloudConvert is a powerful file conversion service supporting over 200 file formats. It streamlines converting, compressing, and managing documents, media, and more, all in one place.
- [Cloudlayer](https://composio.dev/toolkits/cloudlayer) - Cloudlayer is a document and asset generation service for creating PDFs and images via API or SDKs. It lets you automate high-quality doc creation, saving dev time and reducing manual work.
- [Cloudpress](https://composio.dev/toolkits/cloudpress) - Cloudpress is a content export tool for Google Docs and Notion. It automates publishing to your favorite Content Management Systems.
- [Conversion tools](https://composio.dev/toolkits/conversion_tools) - Conversion Tools is an online service for converting documents between formats such as PDF, Word, Excel, XML, and CSV. It lets you automate complex document workflows with just a few clicks.
- [Convertapi](https://composio.dev/toolkits/convertapi) - ConvertAPI is a robust file conversion service for documents, images, and spreadsheets. It streamlines programmatic format changes and lets developers automate complex workflows with a single API.
- [Craftmypdf](https://composio.dev/toolkits/craftmypdf) - CraftMyPDF is a web-based service for designing and generating PDFs with templates and live data. It streamlines document creation by automating personalized PDFs at scale.
- [Docmosis](https://composio.dev/toolkits/docmosis) - Docmosis generates PDF and Word documents from user-defined templates. It's perfect for merging data fields to quickly produce reports, invoices, and business letters.

## Frequently Asked Questions

### What are the differences in Tool Router MCP and Contentful graphql MCP?

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

### Can I use Tool Router MCP with Pydantic AI?

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 graphql tools.

### Can I manage the permissions and scopes for Contentful graphql while using Tool Router?

Yes, absolutely. You can configure which Contentful graphql 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.

### How safe is my data with Composio Tool Router?

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 graphql data and credentials are handled as safely as possible.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)
