Contentful with OpenAI Agents SDK

How to integrate Contentful MCP with OpenAI Agents SDK

Trusted by

GET STARTED FOR FREE GET A DEMO

30 min · no commitment · see it on your stack

Introduction Also integrate Contentful with TL;DR What is OpenAI Agents SDK What is the Contentful MCP server Supported Tools & Triggers Creating MCP Server - Stand-alone vs Composio SDK Step-by-step Guide Complete Code Conclusion How to build Contentful MCP Agent with another framework Explore Other Toolkits FAQ

Connect Contentful without Auth hassles

We manage OAuth, API Key, token refresh, and scopes, you just build.

Try for Free

Introduction

This guide walks you through connecting Contentful to the OpenAI Agents SDK 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 OpenAI Agents SDK 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

Claude Agent SDK Claude Code Claude Cowork Codex OpenClaw Hermes CLI Google ADK LangChain Vercel AI SDK Mastra AI LlamaIndex CrewAI

TL;DR

Here's what you'll learn:

Get and set up your OpenAI and Composio API keys
Install the necessary dependencies
Initialize Composio and create a Tool Router session for Contentful
Configure an AI agent that can use Contentful as a tool
Run a live chat session where you can ask the agent to perform Contentful operations

What is OpenAI Agents SDK?

The OpenAI Agents SDK is a lightweight framework for building AI agents that can use tools and maintain conversation state. It provides a simple interface for creating agents with hosted MCP tool support.

Key features include:

Hosted MCP Tools: Connect to external services through hosted MCP endpoints
SQLite Sessions: Persist conversation history across interactions
Simple API: Clean interface with Agent, Runner, and tool configuration
Streaming Support: Real-time response streaming for interactive applications

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.

Supported Tools & Triggers

Tools

Activate Content TypeActivates (publishes) a content type in Contentful.

Archive AssetTool to archive an asset in Contentful.

Archive EntryTool to archive an entry in Contentful.

Archive ReleaseTool to archive a release in Contentful.

Create App Signing KeyTool to generate an app signing key for a Contentful app definition.

Create Content TypeTool to create a new content type in a Contentful environment.

Create Entry TaskTool to create a task on a Contentful entry.

Create EnvironmentTool to create a new environment within a Contentful space.

Create App Access GrantCreates an access grant for an app definition to allow organizations to install the app.

Create Organizations App DefinitionsTool to create a new app definition in a Contentful organization.

Create App Definition ActionTool to create an action for a Contentful app definition.

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

Create Organizations Security ContactsCreates a security contact for a specific organization.

Create Organizations Taxonomy ConceptsTool to create a new taxonomy concept in a Contentful organization.

Create Organizations Taxonomy Concept SchemesTool to create a new taxonomy concept scheme in an organization.

Create ReleaseTool to create a new release in Contentful.

Create Delivery API KeyTool to create a new Delivery API key for a Contentful space.

Create AssetTool to create a new asset in a Contentful space environment.

Create EntryTool to create a new entry in a Contentful space environment.

Create Entry CommentTool to create a comment on an entry in Contentful.

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

Create Scheduled ActionTool to create a scheduled action for publishing or unpublishing entries/assets in Contentful.

Delete AssetDeletes an asset by ID from a Contentful environment.

Delete Content TypeDeletes a content type by ID from a Contentful environment.

Delete EntryDeletes an entry by ID from a Contentful environment.

Delete EnvironmentDeletes an environment by ID from a Contentful space.

Delete ExtensionDeletes an extension by ID from a Contentful environment.

Delete App Event SubscriptionDeletes an app event subscription from a Contentful organization.

Delete App Definition DetailsTool to delete app definition details for an organization in Contentful.

Delete App KeyTool to delete an app key from an app definition in a Contentful organization.

Delete App Definition Signing SecretTool to remove the current app signing secret from an app definition.

Delete Organization Security ContactDeletes a security contact from a Contentful organization.

Delete ReleaseDeletes a release by ID from a Contentful environment.

Delete Scheduled ActionCancels a scheduled action by ID in Contentful.

Delete Space MembershipDeletes a space membership by ID from a Contentful space.

Delete Delivery API KeyTool to delete a single Delivery API key from a Contentful space.

Delete Spaces UploadDeletes an upload by ID from a Contentful space.

Delete TagDeletes a tag by ID from a Contentful environment.

Get App BundleRetrieves details of a specific app bundle by its ID.

Get App DefinitionTool to retrieve details of a specific app definition by its ID.

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

Get Content TypesRetrieves all content types in a Contentful environment.

Get Content Type SnapshotTool to retrieve a snapshot of a content type by snapshot ID.

Get Content Type SnapshotsTool to get all snapshots of a content type in Contentful.

Get Editor InterfaceTool to retrieve the editor interface configuration for a content type.

Get Entry CommentTool to retrieve a specific comment from an entry in Contentful.

Get Entry ReferencesTool to retrieve references to a specific entry in Contentful.

Get Entry SnapshotsTool to get all snapshots of an entry in Contentful.

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

Get OrganizationRetrieves details of a specific organization by its ID.

Get Organization Access GrantRetrieves the access grant status for a specific organization.

Get OrganizationsTool to get all organizations an account has access to in Contentful.

Get Organizations AI ProvidersRetrieves all AI providers configured for an organization in Contentful.

Get Organization App Actions CategoriesRetrieves app action categories for a Contentful organization.

Get App Event SubscriptionTool to retrieve details of an app event subscription by organization and app definition ID.

Get Organizations App DefinitionsRetrieves all app definitions for a specific organization.

Get Organizations App Definitions Access GrantsGet all app access grants for a specific app definition within an organization.

Get App Definition ActionsTool to get all actions of an app definition within an organization.

Get App Action DetailsTool to read a specific app action from an app definition within an organization.

Get App Definition App BundlesTool to get all app bundles for a specific app definition within an organization.

Get App Definition FunctionsTool to get all functions of an app definition within an organization.

Get App Definition KeysTool to retrieve all app keys for a specific app definition in a Contentful organization.

Get App Definition Signing SecretTool to retrieve the current app signing secret for an app definition.

Get Organization EnablementsRetrieves feature enablements for a specific organization in Contentful.

Get Organization InvitationRetrieves a single invitation for an organization (alpha).

Get Organization Periodic UsagesTool to get organization periodic usage statistics.

Get Organization RolesRetrieves all space roles in an organization.

Get Organization Security ContactsRetrieves security contacts for a specific organization that an admin or owner has access to.

Get Organizations Space EnablementsRetrieves all space enablements for a specific organization.

Get Organizations Space Periodic UsagesTool to retrieve space periodic usage data for an organization.

Get Organizations Taxonomy ConceptsRetrieves all taxonomy concepts for an organization in Contentful.

Get Taxonomy Concept AncestorsRetrieves the list of ancestor concepts for a specific taxonomy concept.

Get Organizations Taxonomy Concept SchemesTool to retrieve all taxonomy concept schemes from an organization.

Get Taxonomy Concept SchemeTool to retrieve a specific taxonomy concept scheme from an organization.

Get Organizations Taxonomy Concept Schemes TotalRetrieves the total count of taxonomy concept schemes for a specific organization.

Get Organizations Taxonomy Concepts TotalRetrieves the total count of taxonomy concepts for a specific organization.

Get ReleaseTool to get a single release by ID from Contentful.

Get spaceRetrieves metadata of a specific space by its ID.

Get Space MembershipsTool to get all space memberships in a Contentful space.

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

Get Space EnvironmentsRetrieves all environments of a space in Contentful.

List App InstallationsLists all app installations in a specific Contentful environment.

Get All AssetsRetrieves all assets from a specific environment in a Contentful space.

Get Space Environment LocalesTool to retrieve all locales of a space environment in Contentful.

Get App Installation FunctionsTool to get all functions for an app installation in a Contentful environment.

Get Authenticated UserTool to retrieve information about the currently authenticated user.

List EntriesTool to retrieve all entries from a Contentful space environment.

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

Get All Space RolesTool to retrieve all roles from a Contentful space.

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

Query Asset CollectionTool to retrieve multiple assets with pagination and filtering via GraphQL API.

Query GraphQL Content Type CollectionTool to query a collection of entries for a specific content type using GraphQL.

Update App DefinitionTool to update an app definition by ID in a Contentful organization.

Update Editor InterfaceTool to update the editor interface configuration for a content type.

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

Update App Event SubscriptionTool to update or create an app event subscription in a Contentful organization.

Update App Definition ActionTool to update an action for a Contentful app definition.

Update App Definition DetailsTool to create or update app definition details for an organization in Contentful.

Update App Definition Signing SecretTool to create or overwrite the app signing secret for an app definition.

Update Organization EnablementsUpdates feature enablements for a specific organization in Contentful.

Update Organization Security ContactUpdates an organization security contact that an admin or owner has access to.

Update Organizations Taxonomy ConceptsTool to create or update a taxonomy concept with a user-defined ID in a Contentful organization.

Update Organizations Taxonomy Concept SchemesTool to create or update a taxonomy concept scheme with a user-defined ID in an organization.

Update spaceUpdates the name of a specific space.

Update TagCreates or updates a tag in a Contentful environment.

Validate Bulk ActionTool to validate a bulk action before executing it.

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:

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

Step-by-step Guide

Prerequisites

Before starting, make sure you have:

Composio API Key and OpenAI API Key
Primary know-how of OpenAI Agents SDK
A live Contentful project
Some knowledge of Python or Typescript

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.
Go to Settings and copy your API key.

Install dependencies

pip install composio_openai_agents openai-agents python-dotenv

Install the Composio SDK and the OpenAI Agents SDK.

Set up environment variables

bash

OPENAI_API_KEY=sk-...your-api-key
COMPOSIO_API_KEY=your-api-key
USER_ID=composio_user@gmail.com

Create a .env file and add your OpenAI and Composio API keys.

Import dependencies

import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession

What's happening:

You're importing all necessary libraries.
The Composio and OpenAIAgentsProvider classes are imported to connect your OpenAI agent to Composio tools like Contentful.

Set up the Composio instance

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())

What's happening:

load_dotenv() loads your .env file so OPENAI_API_KEY and COMPOSIO_API_KEY are available as environment variables.
Creating a Composio instance using the API Key and OpenAIAgentsProvider class.

Create a Tool Router session

# Create a Contentful Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["contentful"]
)

mcp_url = session.mcp.url

What is happening:

You give the Tool Router the user id and the toolkits you want available. Here, it is only contentful.
The router checks the user's Contentful connection and prepares the MCP endpoint.
The returned session.mcp.url is the MCP URL that your agent will use to access Contentful.
This approach keeps things lightweight and lets the agent request Contentful tools only when needed during the conversation.

Configure the agent

# Configure agent with MCP tool
agent = Agent(
    name="Assistant",
    model="gpt-5",
    instructions=(
        "You are a helpful assistant that can access Contentful. "
        "Help users perform Contentful operations through natural language."
    ),
    tools=[
        HostedMCPTool(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "never",
            }
        )
    ],
)

What's happening:

We're creating an Agent instance with a name, model (gpt-5), and clear instructions about its purpose.
The agent's instructions tell it that it can access Contentful and help with queries, inserts, updates, authentication, and fetching database information.
The tools array includes a HostedMCPTool that connects to the MCP server URL we created earlier.
The headers dict includes the Composio API key for secure authentication with the MCP server.
require_approval: 'never' means the agent can execute Contentful operations without asking for permission each time, making interactions smoother.

Start chat loop and handle conversation

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())

What's happening:

The program prints a session URL that you visit to authorize Contentful.
After authorization, the chat begins.
Each message you type is processed by the agent using Runner.run().
The responses are printed to the console, and conversations are saved locally using SQLite.
Typing exit, quit, or q cleanly ends the chat.

Complete Code

Here's the complete code to get you started with Contentful and OpenAI Agents SDK:

import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())

# Create Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["contentful"]
)
mcp_url = session.mcp.url

# Configure agent with MCP tool
agent = Agent(
    name="Assistant",
    model="gpt-5",
    instructions=(
        "You are a helpful assistant that can access Contentful. "
        "Help users perform Contentful operations through natural language."
    ),
    tools=[
        HostedMCPTool(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "never",
            }
        )
    ],
)

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())

Conclusion

This was a starter code for integrating Contentful MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Contentful.

Key features:

Hosted MCP tool integration through Composio's Tool Router
SQLite session persistence for conversation history
Simple async chat loop for interactive testing

You can extend this by adding more toolkits, implementing custom business logic, or building a web interface around the agent.

How to build Contentful MCP Agent with another framework

Claude Agent SDK

Use Contentful MCP with Claude Agent SDK

Claude Code

Use Contentful MCP with Claude Code

Claude Cowork

Use Contentful MCP with Claude Cowork

Codex

Use Contentful MCP with Codex

OpenClaw

Use Contentful MCP with OpenClaw

Hermes

Use Contentful MCP with Hermes

CLI

Use Contentful MCP with CLI

Google ADK

Use Contentful MCP with Google ADK

LangChain

Use Contentful MCP with LangChain

Vercel AI SDK

Use Contentful MCP with Vercel AI SDK

Mastra AI

Use Contentful MCP with Mastra AI

LlamaIndex

Use Contentful MCP with LlamaIndex

CrewAI

Use Contentful MCP with CrewAI

Explore Other Toolkits

Supabase

Oauth2Api Key

Supabase is an open-source backend platform offering scalable Postgres databases, authentication, storage, and real-time APIs. It lets developers build modern apps without managing infrastructure.

Codeinterpreter

No Auth

Codeinterpreter is a Python-based coding environment with built-in data analysis and visualization. It lets you instantly run scripts, plot results, and prototype solutions inside supported platforms.

GitHub

Oauth2

GitHub is a code hosting platform for version control and collaborative software development. It streamlines project management, code review, and team workflows in one place.

TOOLKIT MARKETPLACE

FAQ

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

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.

Can I use Tool Router MCP with OpenAI Agents SDK?

Yes, you can. OpenAI Agents SDK 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.

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

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.

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

Used by agents from

Never worry about agent reliability

We handle tool reliability, observability, and security so you never have to second-guess an agent action.

Get started for free Get a demo↗

Harsha GaddipatiCo-founder, Slashy

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

Abhi AryaCo-founder, Opennote

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 has immensely helped in keeping new users on the platform.

Nirman DaveCEO, Zams

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

Ryan YuFounder, Extra Thursday

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

Tomisin JenrolaFounder & CEO, SwarmZero

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

Jerome LeclancheCo-Founder, Ingram Technologies

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.

Harsha GaddipatiCo-founder, Slashy

Abhi AryaCo-founder, Opennote

Nirman DaveCEO, Zams

Ryan YuFounder, Extra Thursday

Tomisin JenrolaFounder & CEO, SwarmZero

Jerome LeclancheCo-Founder, Ingram Technologies

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.

Harsha GaddipatiCo-founder, Slashy

Abhi AryaCo-founder, Opennote

Nirman DaveCEO, Zams

Ryan YuFounder, Extra Thursday

Tomisin JenrolaFounder & CEO, SwarmZero

Jerome LeclancheCo-Founder, Ingram Technologies

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.

How to integrate Contentful MCP with OpenAI Agents SDK

Table of Contents

Connect Contentful without Auth hassles

Introduction

Also integrate Contentful with

TL;DR

What is OpenAI Agents SDK?

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

Supported Tools & Triggers

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

What is Composio SDK?

How the Composio SDK works

Step-by-step Guide

Prerequisites

Getting API Keys for OpenAI and Composio

Install dependencies

Set up environment variables

Import dependencies

Set up the Composio instance

Create a Tool Router session

Configure the agent

Start chat loop and handle conversation

Complete Code

Conclusion

How to build Contentful MCP Agent with another framework

Claude Agent SDK

Claude Code

Claude Cowork

Codex

OpenClaw

Hermes

CLI

Google ADK

LangChain

Vercel AI SDK

Mastra AI

LlamaIndex

CrewAI

Explore Other Toolkits

Supabase

Codeinterpreter

GitHub

FAQ

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

Can I use Tool Router MCP with OpenAI Agents SDK?

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

How safe is my data with Composio Tool Router?

Used by agents from

Never worry about agent reliability