Paradym with OpenAI Agents SDK

How to integrate Paradym MCP with OpenAI Agents SDK

Trusted by

GET STARTED FOR FREE GET A DEMO

30 min · no commitment · see it on your stack

Introduction Also integrate Paradym with TL;DR What is OpenAI Agents SDK What is the Paradym MCP server Supported Tools & Triggers Creating MCP Server - Stand-alone vs Composio SDK Step-by-step Guide Complete Code Conclusion How to build Paradym MCP Agent with another framework Explore Other Toolkits FAQ

Connect Paradym without Auth hassles

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

Try for Free

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

Supported Tools & Triggers

Tools

Activate CertificateTool to activate a certificate for use in a project.

Archive AnonCreds Credential TemplateTool to archive an AnonCreds credential template in a project.

Archive mDoc Credential TemplateTool to archive an mDoc credential template.

Archive Presentation TemplateTool to archive a presentation template in a project.

Archive SD-JWT VC Credential TemplateTool to archive an SD-JWT VC credential template in a project.

Create AnonCreds Credential TemplateTool to create a new AnonCreds credential template.

Create CertificateTool to create a new self-signed X.

Create DIDComm Connection InvitationTool to create a DIDComm connection invitation.

Create DIDComm Issuance OfferTool to create a DIDComm credential issuance offer.

Create OpenID4VC Credential OfferTool to create an OpenID4VC credential offer.

Create OpenID4VC Verification RequestTool to create an OpenID4VC verification request.

Create Presentation TemplateTool to create a new presentation template.

Create Project WebhookTool to create a new webhook for a project.

Create SD-JWT VC Credential TemplateTool to create a new SD-JWT VC credential template with selective disclosure capabilities.

Create Trusted EntityTool to create a new trusted entity for a project.

Deactivate CertificateTool to deactivate a certificate in a project.

Delete DIDComm ConnectionTool to delete a DIDComm connection from a project.

Delete DIDComm InvitationTool to delete a DIDComm invitation from a project.

Delete Trusted EntityTool to delete a trusted entity from a project.

Delete Project WebhookTool to delete a webhook endpoint from a project.

Get AnonCreds Credential TemplateTool to retrieve a specific AnonCreds credential template by ID.

Get AnonCreds Credential Template JSON SchemaTool to retrieve the JSON schema for an AnonCreds credential template.

Get DIDComm ConnectionTool to retrieve a specific DIDComm connection by ID.

Get DIDComm ConnectionsTool to retrieve a list of DIDComm connections for a project.

Get DIDComm InvitationTool to retrieve a specific DIDComm invitation by ID.

Get DIDComm Issuance SessionTool to retrieve a specific DIDComm issuance session by ID.

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

Get mDoc Credential TemplateTool to retrieve a specific mDoc credential template by ID.

Get mDoc Credential Template JSON SchemaTool to retrieve the JSON schema for an mDoc credential template.

Get OpenID4VC Issuance SessionTool to retrieve a specific OpenID4VC issuance session by ID.

Get OpenID4VC Verification SessionTool to retrieve a specific OpenID4VC verification session by ID.

Get Presentation TemplateTool to retrieve a specific presentation template by ID.

Get Presentation TemplatesTool to retrieve a list of presentation templates for a project.

Get Project MembersTool to retrieve a list of project members.

Get Project ProfileTool to retrieve the default profile for a project.

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

Get Project WebhooksTool to retrieve a list of webhooks configured for a specific project.

Get SD-JWT VC Credential TemplateTool to retrieve a specific SD-JWT VC credential template by ID.

Get SD-JWT VC Credential Template JSON SchemaTool to retrieve the JSON schema for an SD-JWT VC credential template.

Get Trusted EntitiesTool to retrieve trusted entities for a specific project.

Get Trusted EntityTool to retrieve a specific trusted entity by ID.

Issue Direct SD-JWT VCTool to directly issue an SD-JWT VC credential without exchange protocol.

List AnonCreds Credential TemplatesTool to retrieve all AnonCreds credential templates for a project.

List CertificatesTool to retrieve all X.

List Certificate Signing RequestsTool to retrieve all certificate signing requests for a project.

List DIDComm InvitationsTool to retrieve all DIDComm invitations for a project.

List DIDComm Issuance OffersTool to list all DIDComm issuance offers within a project.

List DIDComm Mediator ConnectionsTool to retrieve connections for a DIDComm mediator.

List DIDComm MediatorsTool to retrieve all DIDComm mediators for a project.

List DIDComm Verification RequestsTool to list all DIDComm verification sessions for a project.

List Issued CredentialsTool to list metadata for all issued credentials within a project.

List mDoc Credential TemplatesTool to retrieve all mDoc credential templates for a project.

List OpenID4VC Issuance SessionsTool to retrieve all OpenID4VC issuance sessions for a project.

List OpenID4VC Verification SessionsTool to retrieve all OpenID4VC verification sessions for a project.

List SD-JWT VC Credential TemplatesTool to retrieve all SD-JWT VC credential templates for a project.

Receive DIDComm InvitationTool to receive and process an external DIDComm invitation.

Revoke CertificateTool to revoke a certificate in a project.

Send DIDComm Basic MessageTool to send a basic DIDComm message to a connection.

Send Custom DIDComm MessageTool to send a custom DIDComm message to a connection.

Unarchive AnonCreds Credential TemplateTool to unarchive an archived AnonCreds credential template.

Unarchive mDoc Credential TemplateTool to unarchive an archived mDoc credential template.

Unarchive SD-JWT VC Credential TemplateTool to unarchive an archived SD-JWT VC credential template.

Update DIDComm ConnectionTool to update a DIDComm connection.

Update mDoc Credential TemplateTool to update an existing mDoc credential template.

Update Presentation TemplateTool to update an existing presentation template.

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

Update Project ProfileTool to update the default profile for a project.

Update SD-JWT VC Credential TemplateTool to update an existing SD-JWT VC credential template.

Update Trusted EntityTool to update an existing trusted entity in a project.

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

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

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

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

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

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

Configure the agent

# Configure agent with MCP tool
agent = 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(
            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 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 dict includes the Composio API key for secure authentication with the MCP server.
require_approval: 'never' means the agent can execute Paradym 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 Paradym.
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 Paradym 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=["paradym"]
)
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 Paradym. "
        "Help users perform Paradym 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 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.

How to build Paradym MCP Agent with another framework

Claude Agent SDK

Use Paradym MCP with Claude Agent SDK

Claude Code

Use Paradym MCP with Claude Code

Claude Cowork

Use Paradym MCP with Claude Cowork

Codex

Use Paradym MCP with Codex

OpenClaw

Use Paradym MCP with OpenClaw

Hermes

Use Paradym MCP with Hermes

CLI

Use Paradym MCP with CLI

Google ADK

Use Paradym MCP with Google ADK

LangChain

Use Paradym MCP with LangChain

Vercel AI SDK

Use Paradym MCP with Vercel AI SDK

Mastra AI

Use Paradym MCP with Mastra AI

LlamaIndex

Use Paradym MCP with LlamaIndex

CrewAI

Use Paradym MCP with CrewAI

Explore Other Toolkits

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.

TOOLKIT MARKETPLACE

FAQ

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

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.

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

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

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.

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 Paradym data and credentials are handled as safely as possible.

Used by agents from

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 free Get a demo↗

Harsha GaddipatiCo-founder, Slashy

Karan skipped his own birthday party to fix our critical issue. It was 10 pm and he diverted his Waymo to help us instead. This really sets the bar, shows you the commitment you need to have when users rely on your software.

Abhi AryaCo-founder, Opennote

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 has immensely helped in keeping new users on the platform.

Nirman DaveCEO, Zams

We chose Composio over Pipedream because it delivered depth where it mattered. It supported niche tools and tricky edge cases that other platforms simply ignored. Giving us confidence to scale without compromising.

Ryan YuFounder, Extra Thursday

As a solo builder, shipping fast is life or death. The only way I can outcompete incumbents is by outmanoeuvring them. Getting bogged down in the complexities of managing agent auth would have been a death sentence for Extra Thursday.

Tomisin JenrolaFounder & CEO, SwarmZero

Before partnering with Composio, adding tool integrations was a slow, resource-intensive process. Each integration could take weeks or months of engineering time, and maintaining them meant constantly keeping up with API changes.

Jerome LeclancheCo-Founder, Ingram Technologies

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.

Harsha GaddipatiCo-founder, Slashy

Abhi AryaCo-founder, Opennote

Nirman DaveCEO, Zams

Ryan YuFounder, Extra Thursday

Tomisin JenrolaFounder & CEO, SwarmZero

Jerome LeclancheCo-Founder, Ingram Technologies

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.

Harsha GaddipatiCo-founder, Slashy

Abhi AryaCo-founder, Opennote

Nirman DaveCEO, Zams

Ryan YuFounder, Extra Thursday

Tomisin JenrolaFounder & CEO, SwarmZero

Jerome LeclancheCo-Founder, Ingram Technologies

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.

How to integrate Paradym MCP with OpenAI Agents SDK

Table of Contents

Connect Paradym without Auth hassles

Introduction

Also integrate Paradym with

TL;DR

What is OpenAI Agents SDK?

What is the Paradym MCP server, and what's possible with it?

Supported Tools & Triggers

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

How to build Paradym 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

FAQ

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

Can I use Tool Router MCP with OpenAI Agents SDK?

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

How safe is my data with Composio Tool Router?

Used by agents from

Never worry about agent reliability