How to integrate Contentful MCP with OpenAI Agents SDK

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.

Get started for free Get a demo

Contentful

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

Managed auth

Connect Contentful without auth hassles

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

Try for free

Introduction

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.

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

Step by step09 STEPS

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

npm install @composio/openai-agents @openai/agents 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 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';

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

dotenv.config();

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});

What's happening:

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

Create a Tool Router session

// Create Tool Router session for Contentful
const session = await composio.create(userId as string, {
  toolkits: ['contentful'],
});
const mcpUrl = 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
const agent = new 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({
      serverLabel: 'tool_router',
      serverUrl: mcpUrl,
      headers: { 'x-api-key': composioApiKey },
      requireApproval: '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 object includes the Composio API key for secure authentication with the MCP server.
requireApproval: 'never' means the agent can execute Contentful operations without asking for permission each time, making interactions smoother.

Start chat loop and handle conversation

// Keep conversation state across turns
const conversationSession = new OpenAIConversationsSession();

// Simple CLI
const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
  prompt: 'You: ',
});

console.log('\nComposio Tool Router session created.');
console.log('\nChat started. Type your requests below.');
console.log("Commands: 'exit', 'quit', or 'q' to end\n");

try {
  const first = await run(agent, 'What can you help me with?', { session: conversationSession });
  console.log(`Assistant: ${first.finalOutput}\n`);
} catch (e) {
  console.error('Error:', e instanceof Error ? e.message : e, '\n');
}

rl.prompt();

rl.on('line', async (userInput) => {
  const text = userInput.trim();

  if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
    console.log('Goodbye!');
    rl.close();
    process.exit(0);
  }

  if (!text) {
    rl.prompt();
    return;
  }

  try {
    const result = await run(agent, text, { session: conversationSession });
    console.log(`\nAssistant: ${result.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();
});

rl.on('close', () => {
  console.log('\n👋 Session ended.');
  process.exit(0);
});

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 run().
The responses are printed to the console.
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 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});

async function main() {
  // Create Tool Router session
  const session = await composio.create(userId as string, {
    toolkits: ['contentful'],
  });
  const mcpUrl = session.mcp.url;

  // Configure agent with MCP tool
  const agent = new 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({
        serverLabel: 'tool_router',
        serverUrl: mcpUrl,
        headers: { 'x-api-key': composioApiKey },
        requireApproval: 'never',
      }),
    ],
  });

  // Keep conversation state across turns
  const conversationSession = new OpenAIConversationsSession();

  // Simple CLI
  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: 'You: ',
  });

  console.log('\nComposio Tool Router session created.');
  console.log('\nChat started. Type your requests below.');
  console.log("Commands: 'exit', 'quit', or 'q' to end\n");

  try {
    const first = await run(agent, 'What can you help me with?', { session: conversationSession });
    console.log(`Assistant: ${first.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();

  rl.on('line', async (userInput) => {
    const text = userInput.trim();

    if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
      console.log('Goodbye!');
      rl.close();
      process.exit(0);
    }

    if (!text) {
      rl.prompt();
      return;
    }

    try {
      const result = await run(agent, text, { session: conversationSession });
      console.log(`\nAssistant: ${result.finalOutput}\n`);
    } catch (e) {
      console.error('Error:', e instanceof Error ? e.message : e, '\n');
    }

    rl.prompt();
  });

  rl.on('close', () => {
    console.log('\nSession ended.');
    process.exit(0);
  });
}

main().catch((err) => {
  console.error('Fatal error:', err);
  process.exit(1);
});

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.

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

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

MORE TOOLKITS

Explore Other Toolkits

Toolkit marketplace

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.

Ably

Api Key

Ably is a real-time messaging platform for live chat and data sync in modern apps. It offers global scale and rock-solid reliability for seamless, instant experiences.

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

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 FREE BOOK A DEMO

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

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

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

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

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

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

Co-Founder, Ingram Technologies

How to integrate Contentful MCP with OpenAI Agents SDK

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?

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

Supported Tools

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

Ably

Frequently asked questions

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?+

Start with Contentful.It takes 30 seconds.

Teams ship real agents on Composio