How to integrate Affinda MCP with OpenAI Agents SDK

Trusted by
AWS
Glean
Zoom
Airtable
GET STARTED FOR FREEGET A DEMO

30 min · no commitment · see it on your stack

Affinda logo
OpenAI Agents SDK logo
divider

Introduction

This guide walks you through connecting Affinda to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Affinda agent that can extract invoice data from uploaded pdf, delete a document no longer needed, create a new tag for hr documents through natural language commands.

This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Affinda account through Composio's Affinda MCP server.

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

Also integrate Affinda with

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 Affinda
  • Configure an AI agent that can use Affinda as a tool
  • Run a live chat session where you can ask the agent to perform Affinda 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 Affinda MCP server, and what's possible with it?

The Affinda MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Affinda account. It provides structured and secure access to your document processing workflows, so your agent can upload files, extract data, organize workspaces, label documents, and automate annotation management on your behalf.

  • AI-powered document upload and extraction: Instantly have your agent upload new documents for parsing and extract structured data from various formats using Affinda's advanced AI models.
  • Workspace and collection management: Let your agent create, group, and organize documents into collections and workspaces, keeping your document processing streamlined and organized.
  • Automated annotation updates: Empower your agent to batch update or modify multiple document annotations in a single request, saving you time on manual corrections.
  • Document tagging and organization: Direct your agent to create tags and label documents, making it easy to categorize and quickly retrieve important files.
  • Effortless cleanup and resource management: Have your agent delete unwanted documents or collections, ensuring your Affinda account stays tidy and relevant at all times.

Supported Tools & Triggers

Tools
Add Tag to DocumentsTool to add a tag to multiple documents in a single operation.
Batch Update AnnotationsBatch update multiple document annotations in a single API call.
Create API UserTool to create a new API user within an organization.
Batch Create AnnotationsBatch create multiple document annotations in a single API call.
Create CollectionTool to create a new collection.
Create Data Field For CollectionTool to create a data field for a collection along with a new data point.
Create Data SourceTool to create a custom mapping data source.
Create Data Source ValueTool to add a new value to a mapping data source.
Create DocumentUpload a document to Affinda for parsing and data extraction.
Create Document TypeTool to create a new document type in the specified organization.
Create ExtractorTool to create a new extractor.
Create Document from DataCreate a document from structured resume or job description data for Search & Match.
Create IndexTool to create a new index for search and match functionality.
Create InvitationTool to create a new organization invitation.
Create Job Description SearchSearch through parsed job descriptions using custom criteria or resume matching.
Create Job Description Search Embed URLTool to create and return a signed URL for the embeddable job description search tool.
Create OrganizationTool to create a new organization.
Create RESTHook SubscriptionTool to create a new RESTHook subscription.
Create Resume SearchTool to search through parsed resumes using three methods: match to a job description, match to a resume, or custom criteria.
Create Resume Search Embed URLTool to create and return a signed URL for the embeddable resume search tool.
Create TagCreates a new tag in the specified workspace.
Create Validation ResultCreate a validation result for document annotations in Affinda.
Batch Create Validation ResultsBatch create multiple validation results for document annotations in a single API call.
Create WorkspaceTool to create a new workspace.
Create Workspace MembershipTool to add a user to a workspace by creating a membership.
Batch Delete AnnotationsBatch delete multiple document annotations in a single API call.
Delete CollectionPermanently delete a collection from Affinda by its identifier.
Delete Data SourcePermanently delete a mapping data source from the database by its identifier.
Delete Data Source ValueTool to delete a specific value from a mapping data source.
Delete DocumentTool to delete a specific document by its ID.
Delete Document TypeTool to permanently delete a document type by its identifier.
Delete IndexTool to permanently delete an index from Affinda by its name.
Delete InvitationTool to delete an invitation by its identifier.
Delete OrganizationPermanently deletes an organization from Affinda.
Delete Resthook SubscriptionTool to delete a specific resthook subscription by ID.
Delete TagPermanently delete a tag from Affinda by its ID.
Delete Validation ResultsDelete multiple validation results in a single API call.
Delete WorkspaceTool to delete a specific workspace by its ID.
Delete Workspace MembershipTool to remove a user from a workspace by membership ID.
Get All API UsersTool to retrieve a list of all API users.
Get All Document SplittersTool to get a list of all document splitters.
Get All InvitationsTool to retrieve all invitations you created or sent to you.
Get Organization MembershipsRetrieve all organization memberships across the account.
Get TagsTool to list all tags.
Get All Validation ResultsTool to list validation results for documents.
Get Workspace MembershipsRetrieve all workspace memberships across the account.
Get AnnotationsRetrieves all annotations for a specific document.
Get CollectionTool to retrieve details of a specific collection by its ID.
Get CollectionsTool to retrieve a list of all collections.
Get Data SourceTool to retrieve details of a specific mapping data source by its identifier.
Get Data Source ValueTool to retrieve a specific value from a mapping data source.
Get Data Source ValuesTool to retrieve all values from a mapping data source.
Get DocumentRetrieve full details and parsed data for a specific document by its identifier.
Get Document RedactedTool to retrieve the redacted version of a document as a PDF file.
Get DocumentsTool to retrieve a list of all documents.
Get Document SplitterTool to retrieve details of a specific document splitter by its identifier.
Get Document TypeTool to retrieve details of a specific document type by its ID.
Get Document Type JSON SchemaTool to generate a JSON schema from a document type by its identifier.
Get Document Type Pydantic ModelsTool to generate Pydantic model code from a document type's schema.
Get Document TypesRetrieve all document types accessible to the authenticated user.
Get ExtractorTool to retrieve detailed information about a specific extractor by its identifier.
Get ExtractorsRetrieve all extractors available for an organization.
Get Index DocumentsTool to retrieve all indexed documents for a specific index.
Get InvitationTool to retrieve details of a specific organization invitation by its identifier.
Get Job Description Search ConfigTool to get the configuration for the logged in user's embeddable job description search tool.
Get MappingTool to retrieve a specific mapping by its identifier.
Get OrganizationTool to retrieve details of a specific organization by its ID.
Get Organization MembershipTool to retrieve details of a specific organization membership by its ID.
Get OrganizationsRetrieves all organizations accessible to the authenticated user.
Get Resthook SubscriptionTool to retrieve details of a specific resthook subscription by its ID.
Get RESTHook SubscriptionsTool to retrieve a list of all RESTHook subscriptions.
Get TagTool to retrieve details of a specific tag by its ID.
Get Usage by WorkspaceRetrieves monthly document processing usage statistics for a specific workspace.
Get WorkspaceTool to retrieve details of a specific workspace by its ID.
Get Workspace MembershipTool to retrieve details of a specific workspace membership by its ID.
Get WorkspacesTool to retrieve a list of all workspaces.
List Data PointsTool to retrieve all data points.
List Data SourcesTool to retrieve the list of all custom mapping data sources.
List IndexesTool to retrieve a list of all search indexes.
List MappingsTool to retrieve the list of all custom data mappings.
List Occupation GroupsTool to retrieve the list of searchable occupation groups.
List Resume Search ConfigTool to get the configuration for the logged in user's embeddable resume search tool.
List Resume Search Job Title SuggestionsTool to get job title suggestions based on provided job title(s).
List Resume Search Skill SuggestionsTool to get skill suggestions based on provided skills.
Remove Tag from DocumentsRemove a tag from multiple documents in a single batch operation.
Replace Data Source ValuesTool to completely replace all values in a mapping data source.
Split Document PagesSplit a document into multiple documents by dividing its pages.
Update AnnotationTool to update data of a single annotation in Affinda.
Update CollectionTool to update specific fields of a collection.
Update Data Field For CollectionTool to update a data field configuration for a collection's data point.
Update Data Source ValueTool to update an existing value in a mapping data source.
Update DocumentTool to update specific fields of a document.
Update Document DataUpdate parsed data for a resume or job description document in Affinda.
Update Document TypeTool to update a document type by its identifier.
Update ExtractorTool to update specific fields of an extractor.
Update IndexTool to update the name of an existing search index.
Update InvitationTool to update an organization invitation's role.
Update Job Description Search ConfigTool to update the configuration for the logged in user's embeddable job description search tool.
Update MappingTool to update a specific mapping's settings.
Update OrganizationTool to update specific fields of an organization.
Update Organization MembershipTool to update an organization membership's role.
Update RESTHook SubscriptionTool to update an existing RESTHook subscription.
Update Resume Search ConfigTool to update the configuration for the logged in user's embeddable resume search tool.
Update TagTool to update data of a tag.
Update WorkspaceTool to update specific fields of a workspace.

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

Prerequisites

Before starting, make sure you have:
  • Composio API Key and OpenAI API Key
  • Primary know-how of OpenAI Agents SDK
  • A live Affinda 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

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

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 Affinda Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["affinda"]
)

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 affinda.
  • The router checks the user's Affinda connection and prepares the MCP endpoint.
  • The returned session.mcp.url is the MCP URL that your agent will use to access Affinda.
  • This approach keeps things lightweight and lets the agent request Affinda 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 Affinda. "
        "Help users perform Affinda 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 Affinda 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 Affinda 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 Affinda.
  • 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 Affinda 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=["affinda"]
)
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 Affinda. "
        "Help users perform Affinda 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 Affinda MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Affinda.

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 Affinda MCP Agent with another framework

Claude Agent SDK logo

Claude Agent SDK

Use Affinda MCP with Claude Agent SDK

Claude Code logo

Claude Code

Use Affinda MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use Affinda MCP with Claude Cowork

Codex logo

Codex

Use Affinda MCP with Codex

OpenClaw logo

OpenClaw

Use Affinda MCP with OpenClaw

Hermes logo

Hermes

Use Affinda MCP with Hermes

CLI logo

CLI

Use Affinda MCP with CLI

Google ADK logo

Google ADK

Use Affinda MCP with Google ADK

LangChain logo

LangChain

Use Affinda MCP with LangChain

Vercel AI SDK logo

Vercel AI SDK

Use Affinda MCP with Vercel AI SDK

Mastra AI logo

Mastra AI

Use Affinda MCP with Mastra AI

LlamaIndex logo

LlamaIndex

Use Affinda MCP with LlamaIndex

CrewAI logo

CrewAI

Use Affinda MCP with CrewAI

FAQ

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

With a standalone Affinda MCP server, the agents and LLMs can only access a fixed set of Affinda tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Affinda 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 Affinda tools.

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

Yes, absolutely. You can configure which Affinda 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 Affinda data and credentials are handled as safely as possible.

Used by agents from

Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai

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 freeGet a demo↗