How to integrate Encodian 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

Encodian logo
OpenAI Agents SDK logo
divider

Introduction

This guide walks you through connecting Encodian to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Encodian agent that can resize all images in project folder, extract author and page count from pdf, add custom header to every pdf file through natural language commands.

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

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

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

The Encodian MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Encodian account. It provides structured and secure access to your Encodian document automation suite, so your agent can perform actions like managing files, processing PDFs, encoding or decoding content, and automating workflow tasks on your behalf.

  • File management and property retrieval: Quickly get detailed information about files, move documents between containers, and keep your Microsoft 365 storage organized automatically.
  • Document processing and automation: Direct your agent to add headers and footers to PDFs, extract PDF metadata, or resize images for seamless document formatting and compliance tasks.
  • Base64 content conversion: Effortlessly encode text or files to Base64, or decode Base64 strings back to usable files for secure data exchange and workflow integration.
  • Archive extraction and manipulation: Unzip files and retrieve their contents, making it easy to automate bulk document handling or trigger downstream processing steps.
  • Data integrity and comparison tools: Use hashing and text comparison utilities to verify file integrity, detect changes, or ensure consistency across your documents and workflows.

Supported Tools & Triggers

Tools
Add Attachments to PDFTool to add file attachments to a PDF document.
Add Image Watermark to PDFTool to add an image watermark to a PDF document.
Add Image Watermark to PDF (Advanced)Tool to add an advanced image watermark to a PDF with precise control over positioning, opacity, scale, quality, and rotation.
Array Add ItemsTool to add items to a JSON array at a specified position (first, last, or specific index).
Create ZIP ArchiveTool to create a ZIP archive from multiple documents.
Apply AI OCR to PDFTool to apply AI-powered OCR to a PDF document with optional preprocessing filters.
Apply OCR to PDF (Standard)Tool to apply standard OCR to a PDF document with optional preprocessing filters.
Decode Base64 StringTool to decode a Base64 string to a file.
Base64 EncodeTool to encode a string to Base64.
Calculate DateTool to calculate a date by adding or subtracting a time interval from a given date.
Check Array Contains ValueTool to check if a value exists within a JSON array.
Check Text Contains ValueTool to check if a text string contains a specific value with configurable comparison rules.
Clean StringTool to clean text by removing control characters, invalid filename characters, and custom character sets.
Clean Up Photo ImageTool to clean up photo images by removing artifacts, correcting orientation, and enhancing quality.
Combine ArraysTool to combine two JSON arrays by matching a key attribute.
Compare TextTool to compare two text strings and determine if they match.
Compare Word DocumentsTool to compare two Microsoft Word or PDF documents and generate a document with tracked changes.
Compress ImageTool to compress an image in JPG or PNG format.
Compress PDFTool to compress a PDF document by optimizing images, removing unused objects, and applying various compression techniques.
Concatenate TextTool to concatenate an array of text values with an optional delimiter.
Array to JSONTool to convert an array to a named JSON object.
Array to XMLTool to convert a JSON array to XML format.
Convert File to PDFTool to convert a file to PDF format.
Convert HTML to ImageTool to convert HTML content to an image.
Convert HTML to PDF (V2)Tool to convert HTML content or a URL to PDF format (V2).
Convert HTML to WordTool to convert HTML content to Word (DOCX) format.
Convert Image to GrayscaleTool to convert an image to grayscale.
Convert Image to PDFTool to convert an image file to PDF format with optional OCR.
Convert JSON to ExcelTool to convert JSON data to Excel format.
Convert JSON to XMLTool to convert JSON data to XML format.
Convert Time ZoneTool to convert a date and time value from one time zone to another using Encodian's time zone conversion API.
Convert XML to JSONTool to convert XML strings to JSON format.
Count Array ItemsTool to count the number of items in a JSON array or object.
Create QR CodeTool to generate a QR code barcode image with customizable size, colors, border, and encoding options.
Format Text CaseTool to format text with various case transformations (uppercase, lowercase, title case, etc.
Hash DataTool to compute a cryptographic hash (MD5, SHA256, etc.
Unzip FileExtracts all files from a ZIP archive and returns their base64-encoded contents.
Get Convert Excel SchemaTool to retrieve the dynamic schema for Excel conversion operations.
Get Convert Word SchemaTool to retrieve the dynamic JSON schema for Word document conversion operations.
Get Convert CAD SchemaTool to retrieve the dynamic schema for CAD file conversion operations.
Get Convert Image to PDF SchemaTool to retrieve the dynamic schema for Convert - Image to PDF operations.
Get Convert PowerPoint SchemaTool to retrieve the dynamic schema for PowerPoint conversion operations.
Get Convert Visio SchemaTool to retrieve the dynamic schema for Visio file conversion.
Get Create Barcode SchemaTool to retrieve the dynamic schema for creating a barcode.
Get Crop Image SchemaTool to retrieve the dynamic schema for the Crop Image action.
Get Dynamic Schema for HTTP RequestTool to retrieve the dynamic schema for the HTTP Request utility based on authentication type.
Get Word Insert Text SchemaTool to retrieve the dynamic schema for Word Insert Text operations.
Get File PropertiesTool to retrieve properties of a file.
Get Operation Status for AIRunPromptTextTool to get the operation status of an AIRunPromptText operation.
Get Operation Status for Encodian Send to FilerTool to get the operation status for an Encodian Send to Filer operation.
Get Operation Status Extract ImageTool to retrieve the operation status of a PDF ExtractImage operation.
Get Operation Status for ExtractTextRegionTool to retrieve the operation status of an ExtractTextRegion operation.
Get Operation Status File OnlyTool to retrieve operation status for file-only operations.
Get Operation Status for Image Extract TextTool to get the operation status of an ImageExtractText operation.
Get Operation Status for Multiple FilesTool to retrieve the operation status of a Word MultipleFiles operation.
Get Operation Status - PDF Split BarcodeTool to retrieve operation status for a PDF split barcode operation.
Get Operation Status for Split DocumentTool to retrieve the operation status of a PDF SplitDocument operation.
Get Sign PDF SchemaTool to retrieve the dynamic schema for PDF signing operations.
Get Subscription StatusTool to retrieve Encodian subscription status for Flowr and Vertr.
Resize ImageTool to resize an image by percentage or dimensions.
Move FileTool to move a file between containers.
Add PDF Header FooterTool to add HTML header and footer to a PDF.
Get PDF MetadataExtract comprehensive metadata and properties from PDF documents.
Watermark PDFTool to apply a text watermark to a PDF.
Read QR Code from DocumentTool to read QR codes from PDF or DOCX documents.
Word - Replace Text With ImageTool to replace text with an image in a Word document.
Validate Email AddressValidates an email address string against a custom regex pattern using Encodian's validation API.
Validate URL AvailabilityTool to validate the availability of a specified URL.
Write Range to ExcelTool to write values to a cell range in an Excel worksheet.

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

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

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

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

Claude Agent SDK logo

Claude Agent SDK

Use Encodian MCP with Claude Agent SDK

Claude Code logo

Claude Code

Use Encodian MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use Encodian MCP with Claude Cowork

Codex logo

Codex

Use Encodian MCP with Codex

OpenClaw logo

OpenClaw

Use Encodian MCP with OpenClaw

Hermes logo

Hermes

Use Encodian MCP with Hermes

CLI logo

CLI

Use Encodian MCP with CLI

Google ADK logo

Google ADK

Use Encodian MCP with Google ADK

LangChain logo

LangChain

Use Encodian MCP with LangChain

Vercel AI SDK logo

Vercel AI SDK

Use Encodian MCP with Vercel AI SDK

Mastra AI logo

Mastra AI

Use Encodian MCP with Mastra AI

LlamaIndex logo

LlamaIndex

Use Encodian MCP with LlamaIndex

CrewAI logo

CrewAI

Use Encodian MCP with CrewAI

FAQ

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

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

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

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