How to integrate Encodian MCP with OpenAI Agents SDK

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.

Encodian logoEncodian
Api Key

Encodian provides document management and automation tools for Microsoft 365. Enhance productivity with streamlined workflows and seamless file handling.

69 Tools

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.

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

Step by step09 STEPS
1

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
2

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
3

Install dependencies

npm install @composio/openai-agents @openai/agents dotenv

Install the Composio SDK and the OpenAI Agents SDK.

4

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.

5

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

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

Create a Tool Router session

// Create Tool Router session for Encodian
const session = await composio.create(userId as string, {
  toolkits: ['encodian'],
});
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 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.
8

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 Encodian. Help users perform Encodian 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 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 object includes the Composio API key for secure authentication with the MCP server.
  • requireApproval: 'never' means the agent can execute Encodian operations without asking for permission each time, making interactions smoother.
9

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 Encodian.
  • 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 Encodian 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: ['encodian'],
  });
  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 Encodian. Help users perform Encodian 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 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.
TOOLS

Supported Tools

Every Encodian action and event your agent gets out of the box.

Add Attachments to PDF

Tool to add file attachments to a PDF document.

Add Image Watermark to PDF

Tool 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 Items

Tool to add items to a JSON array at a specified position (first, last, or specific index).

Create ZIP Archive

Tool to create a ZIP archive from multiple documents.

Apply AI OCR to PDF

Tool 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 String

Tool to decode a Base64 string to a file.

Base64 Encode

Tool to encode a string to Base64.

Calculate Date

Tool to calculate a date by adding or subtracting a time interval from a given date.

Check Array Contains Value

Tool to check if a value exists within a JSON array.

Check Text Contains Value

Tool to check if a text string contains a specific value with configurable comparison rules.

Clean String

Tool to clean text by removing control characters, invalid filename characters, and custom character sets.

Clean Up Photo Image

Tool to clean up photo images by removing artifacts, correcting orientation, and enhancing quality.

Combine Arrays

Tool to combine two JSON arrays by matching a key attribute.

Compare Text

Tool to compare two text strings and determine if they match.

Compare Word Documents

Tool to compare two Microsoft Word or PDF documents and generate a document with tracked changes.

Compress Image

Tool to compress an image in JPG or PNG format.

Compress PDF

Tool to compress a PDF document by optimizing images, removing unused objects, and applying various compression techniques.

Concatenate Text

Tool to concatenate an array of text values with an optional delimiter.

Array to JSON

Tool to convert an array to a named JSON object.

Array to XML

Tool to convert a JSON array to XML format.

Convert File to PDF

Tool to convert a file to PDF format.

Convert HTML to Image

Tool 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 Word

Tool to convert HTML content to Word (DOCX) format.

Convert Image to Grayscale

Tool to convert an image to grayscale.

Convert Image to PDF

Tool to convert an image file to PDF format with optional OCR.

Convert JSON to Excel

Tool to convert JSON data to Excel format.

Convert JSON to XML

Tool to convert JSON data to XML format.

Convert Time Zone

Tool to convert a date and time value from one time zone to another using Encodian's time zone conversion API.

Convert XML to JSON

Tool to convert XML strings to JSON format.

Count Array Items

Tool to count the number of items in a JSON array or object.

Create QR Code

Tool to generate a QR code barcode image with customizable size, colors, border, and encoding options.

Format Text Case

Tool to format text with various case transformations (uppercase, lowercase, title case, etc.

Hash Data

Tool to compute a cryptographic hash (MD5, SHA256, etc.

Unzip File

Extracts all files from a ZIP archive and returns their base64-encoded contents.

Get Convert Excel Schema

Tool to retrieve the dynamic schema for Excel conversion operations.

Get Convert Word Schema

Tool to retrieve the dynamic JSON schema for Word document conversion operations.

Get Convert CAD Schema

Tool to retrieve the dynamic schema for CAD file conversion operations.

Get Convert Image to PDF Schema

Tool to retrieve the dynamic schema for Convert - Image to PDF operations.

Get Convert PowerPoint Schema

Tool to retrieve the dynamic schema for PowerPoint conversion operations.

Get Convert Visio Schema

Tool to retrieve the dynamic schema for Visio file conversion.

Get Create Barcode Schema

Tool to retrieve the dynamic schema for creating a barcode.

Get Crop Image Schema

Tool to retrieve the dynamic schema for the Crop Image action.

Get Dynamic Schema for HTTP Request

Tool to retrieve the dynamic schema for the HTTP Request utility based on authentication type.

Get Word Insert Text Schema

Tool to retrieve the dynamic schema for Word Insert Text operations.

Get File Properties

Tool to retrieve properties of a file.

Get Operation Status for AIRunPromptText

Tool to get the operation status of an AIRunPromptText operation.

Get Operation Status for Encodian Send to Filer

Tool to get the operation status for an Encodian Send to Filer operation.

Get Operation Status Extract Image

Tool to retrieve the operation status of a PDF ExtractImage operation.

Get Operation Status for ExtractTextRegion

Tool to retrieve the operation status of an ExtractTextRegion operation.

Get Operation Status File Only

Tool to retrieve operation status for file-only operations.

Get Operation Status for Image Extract Text

Tool to get the operation status of an ImageExtractText operation.

Get Operation Status for Multiple Files

Tool to retrieve the operation status of a Word MultipleFiles operation.

Get Operation Status - PDF Split Barcode

Tool to retrieve operation status for a PDF split barcode operation.

Get Operation Status for Split Document

Tool to retrieve the operation status of a PDF SplitDocument operation.

Get Sign PDF Schema

Tool to retrieve the dynamic schema for PDF signing operations.

Get Subscription Status

Tool to retrieve Encodian subscription status for Flowr and Vertr.

Resize Image

Tool to resize an image by percentage or dimensions.

Move File

Tool to move a file between containers.

Add PDF Header Footer

Tool to add HTML header and footer to a PDF.

Get PDF Metadata

Extract comprehensive metadata and properties from PDF documents.

Watermark PDF

Tool to apply a text watermark to a PDF.

Read QR Code from Document

Tool to read QR codes from PDF or DOCX documents.

Word - Replace Text With Image

Tool to replace text with an image in a Word document.

Validate Email Address

Validates an email address string against a custom regex pattern using Encodian's validation API.

Validate URL Availability

Tool to validate the availability of a specified URL.

Write Range to Excel

Tool to write values to a cell range in an Excel worksheet.

FAQ

Frequently asked questions

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.

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.

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.

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.

Start with Encodian.It takes 30 seconds.

Managed auth, hosted MCP servers, and every Encodian tool your agent needs.Free to start.

Start building