How to integrate Paradym MCP with OpenAI Agents SDK

This guide walks you through connecting Paradym to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Paradym agent that can issue sd-jwt verifiable credential for a user, verify authenticity of a presented credential, list all credentials issued to an email address through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Paradym account through Composio's Paradym MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Get started for freeGet a demo
Paradym logoParadym
Api Key

Paradym is an API-first platform for issuing, verifying, and managing verifiable credentials. It streamlines credential workflows using standards like SD-JWT VCs and AnonCreds.

69 Tools

Introduction

This guide walks you through connecting Paradym to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Paradym agent that can issue sd-jwt verifiable credential for a user, verify authenticity of a presented credential, list all credentials issued to an email address through natural language commands.

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

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

Also integrate Paradym with

Claude Agent SDKClaude CodeClaude CoworkCodexOpenClawHermesCLIGoogle ADKLangChainVercel AI SDKMastra AILlamaIndexCrewAI

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

The Paradym MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Paradym account. It provides structured and secure access to your verifiable credential workflows, so your agent can perform actions like issuing credentials, verifying identity claims, managing credential lifecycles, and supporting interoperability across digital identity standards.

  • Automated credential issuance: Instruct your agent to issue new verifiable credentials to users or systems, supporting protocols like SD-JWT VCs and AnonCreds.
  • Seamless credential verification: Enable your agent to verify the authenticity and validity of credentials presented by others, streamlining onboarding and trust checks.
  • Credential lifecycle management: Allow your agent to update, revoke, or renew existing credentials, ensuring full control over your digital identity assets.
  • Interoperability with identity standards: Leverage your agent to work across OpenID4VC, DIDComm, and other standards for maximum compatibility and flexibility.
  • Audit and usage tracking: Task your agent to retrieve detailed logs or status reports on credential activity, helping you maintain compliance and visibility.

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 Paradym 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 Paradym.
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 Paradym
const session = await composio.create(userId as string, {
  toolkits: ['paradym'],
});
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 paradym.
  • The router checks the user's Paradym connection and prepares the MCP endpoint.
  • The returned session.mcp.url is the MCP URL that your agent will use to access Paradym.
  • This approach keeps things lightweight and lets the agent request Paradym 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 Paradym. Help users perform Paradym 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 Paradym 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 Paradym 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 Paradym.
  • 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 Paradym 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: ['paradym'],
  });
  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 Paradym. Help users perform Paradym 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 Paradym MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Paradym.

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 Paradym action and event your agent gets out of the box.

Activate Certificate

Tool to activate a certificate for use in a project.

Archive AnonCreds Credential Template

Tool to archive an AnonCreds credential template in a project.

Archive mDoc Credential Template

Tool to archive an mDoc credential template.

Archive Presentation Template

Tool to archive a presentation template in a project.

Archive SD-JWT VC Credential Template

Tool to archive an SD-JWT VC credential template in a project.

Create AnonCreds Credential Template

Tool to create a new AnonCreds credential template.

Create Certificate

Tool to create a new self-signed X.

Create DIDComm Connection Invitation

Tool to create a DIDComm connection invitation.

Create DIDComm Issuance Offer

Tool to create a DIDComm credential issuance offer.

Create OpenID4VC Credential Offer

Tool to create an OpenID4VC credential offer.

Create OpenID4VC Verification Request

Tool to create an OpenID4VC verification request.

Create Presentation Template

Tool to create a new presentation template.

Create Project Webhook

Tool to create a new webhook for a project.

Create SD-JWT VC Credential Template

Tool to create a new SD-JWT VC credential template with selective disclosure capabilities.

Create Trusted Entity

Tool to create a new trusted entity for a project.

Deactivate Certificate

Tool to deactivate a certificate in a project.

Delete DIDComm Connection

Tool to delete a DIDComm connection from a project.

Delete DIDComm Invitation

Tool to delete a DIDComm invitation from a project.

Delete Trusted Entity

Tool to delete a trusted entity from a project.

Delete Project Webhook

Tool to delete a webhook endpoint from a project.

Get AnonCreds Credential Template

Tool to retrieve a specific AnonCreds credential template by ID.

Get AnonCreds Credential Template JSON Schema

Tool to retrieve the JSON schema for an AnonCreds credential template.

Get DIDComm Connection

Tool to retrieve a specific DIDComm connection by ID.

Get DIDComm Connections

Tool to retrieve a list of DIDComm connections for a project.

Get DIDComm Invitation

Tool to retrieve a specific DIDComm invitation by ID.

Get DIDComm Issuance Session

Tool to retrieve a specific DIDComm issuance session by ID.

Get DIDs

Tool to retrieve a list of Decentralized Identifiers (DIDs) for a specific project.

Get mDoc Credential Template

Tool to retrieve a specific mDoc credential template by ID.

Get mDoc Credential Template JSON Schema

Tool to retrieve the JSON schema for an mDoc credential template.

Get OpenID4VC Issuance Session

Tool to retrieve a specific OpenID4VC issuance session by ID.

Get OpenID4VC Verification Session

Tool to retrieve a specific OpenID4VC verification session by ID.

Get Presentation Template

Tool to retrieve a specific presentation template by ID.

Get Presentation Templates

Tool to retrieve a list of presentation templates for a project.

Get Project Members

Tool to retrieve a list of project members.

Get Project Profile

Tool to retrieve the default profile for a project.

Get Projects

Tool to retrieve a list of all projects accessible to the authenticated user.

Get Project Webhooks

Tool to retrieve a list of webhooks configured for a specific project.

Get SD-JWT VC Credential Template

Tool to retrieve a specific SD-JWT VC credential template by ID.

Get SD-JWT VC Credential Template JSON Schema

Tool to retrieve the JSON schema for an SD-JWT VC credential template.

Get Trusted Entities

Tool to retrieve trusted entities for a specific project.

Get Trusted Entity

Tool to retrieve a specific trusted entity by ID.

Issue Direct SD-JWT VC

Tool to directly issue an SD-JWT VC credential without exchange protocol.

List AnonCreds Credential Templates

Tool to retrieve all AnonCreds credential templates for a project.

List Certificates

Tool to retrieve all X.

List Certificate Signing Requests

Tool to retrieve all certificate signing requests for a project.

List DIDComm Invitations

Tool to retrieve all DIDComm invitations for a project.

List DIDComm Issuance Offers

Tool to list all DIDComm issuance offers within a project.

List DIDComm Mediator Connections

Tool to retrieve connections for a DIDComm mediator.

List DIDComm Mediators

Tool to retrieve all DIDComm mediators for a project.

List DIDComm Verification Requests

Tool to list all DIDComm verification sessions for a project.

List Issued Credentials

Tool to list metadata for all issued credentials within a project.

List mDoc Credential Templates

Tool to retrieve all mDoc credential templates for a project.

List OpenID4VC Issuance Sessions

Tool to retrieve all OpenID4VC issuance sessions for a project.

List OpenID4VC Verification Sessions

Tool to retrieve all OpenID4VC verification sessions for a project.

List SD-JWT VC Credential Templates

Tool to retrieve all SD-JWT VC credential templates for a project.

Receive DIDComm Invitation

Tool to receive and process an external DIDComm invitation.

Revoke Certificate

Tool to revoke a certificate in a project.

Send DIDComm Basic Message

Tool to send a basic DIDComm message to a connection.

Send Custom DIDComm Message

Tool to send a custom DIDComm message to a connection.

Unarchive AnonCreds Credential Template

Tool to unarchive an archived AnonCreds credential template.

Unarchive mDoc Credential Template

Tool to unarchive an archived mDoc credential template.

Unarchive SD-JWT VC Credential Template

Tool to unarchive an archived SD-JWT VC credential template.

Update DIDComm Connection

Tool to update a DIDComm connection.

Update mDoc Credential Template

Tool to update an existing mDoc credential template.

Update Presentation Template

Tool to update an existing presentation template.

Update Project

Tool to update an existing project's name and verification data access settings.

Update Project Profile

Tool to update the default profile for a project.

Update SD-JWT VC Credential Template

Tool to update an existing SD-JWT VC credential template.

Update Trusted Entity

Tool to update an existing trusted entity in a project.

FRAMEWORKS

How to build Paradym MCP Agent with another framework

Claude Agent SDK logo

Claude Agent SDK

Use Paradym MCP with Claude Agent SDK

Claude Code logo

Claude Code

Use Paradym MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use Paradym MCP with Claude Cowork

Codex logo

Codex

Use Paradym MCP with Codex

OpenClaw logo

OpenClaw

Use Paradym MCP with OpenClaw

Hermes logo

Hermes

Use Paradym MCP with Hermes

CLI logo

CLI

Use Paradym MCP with CLI

Google ADK logo

Google ADK

Use Paradym MCP with Google ADK

LangChain logo

LangChain

Use Paradym MCP with LangChain

Vercel AI SDK logo

Vercel AI SDK

Use Paradym MCP with Vercel AI SDK

Mastra AI logo

Mastra AI

Use Paradym MCP with Mastra AI

LlamaIndex logo

LlamaIndex

Use Paradym MCP with LlamaIndex

CrewAI logo

CrewAI

Use Paradym MCP with CrewAI

FAQ

Frequently asked questions

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

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

Start with Paradym.It takes 30 seconds.

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

Start building
Customer stories

Teams ship real agents on Composio

GET STARTED FOR FREEBOOK A DEMO
agent.aiZoomLettaGleanHubSpotAWSWabi

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
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
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
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
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
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
Jerome Leclanche
Co-Founder, Ingram Technologies