How to integrate Swaggerhub MCP with OpenAI Agents SDK

This guide walks you through connecting Swaggerhub to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Swaggerhub agent that can list all apis i have access to, create a new api named petstore, update the description for your orders api through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Swaggerhub account through Composio's Swaggerhub MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Swaggerhub logoSwaggerhub
Api Key

Swaggerhub is a collaborative API design and documentation platform built on OpenAPI. It accelerates API delivery, quality, and teamwork with powerful standards and workflow tools.

49 Tools

Introduction

This guide walks you through connecting Swaggerhub to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Swaggerhub agent that can list all apis i have access to, create a new api named petstore, update the description for your orders api through natural language commands.

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

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

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

The Swaggerhub MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Swaggerhub account. It provides structured and secure access so your agent can perform Swaggerhub operations on your behalf.

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

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

Add Access Control for Teams

Tool to assign access control roles to teams on a SwaggerHub resource.

Add Access Control for Users

Tool to assign access control roles to users on a SwaggerHub resource.

Delete Table of Contents Entry

Tool to delete a table of contents entry from SwaggerHub portal.

Get Access Control Users

Tool to retrieve the list of users assigned access control on a SwaggerHub resource.

Get API Default Version

Tool to get the default version identifier of a SwaggerHub API.

Get API Versions

Tool to retrieve a list of API versions for a specific API in SwaggerHub.

Get Consumer Products

Tool to get a list of products that are visible to the consumer in a SwaggerHub portal.

Get API Definition

Tool to get the OpenAPI definition of a specified API version from SwaggerHub.

Get Domain Default Version

Tool to retrieve the default version identifier of a SwaggerHub domain.

Get domain definition

Tool to retrieve the OpenAPI definition of a specified domain version from SwaggerHub.

Get Domain JSON Definition

Tool to retrieve the OpenAPI definition for a specified domain version in JSON format.

Get Domain Lifecycle Settings

Tool to get the published status for a specific domain and version in SwaggerHub.

Get Domain Private Settings

Tool to retrieve the visibility (public or private) of a domain version in SwaggerHub.

Get Domain Versions

Tool to get a list of domain versions from SwaggerHub.

Get Domain YAML Definition

Tool to retrieve the OpenAPI definition for a specified domain version in YAML format from SwaggerHub.

Get JSON API Definition

Tool to download OpenAPI definition as a JSON file from SwaggerHub Portal API.

Get JSON Definition

Tool to get the OpenAPI definition for a specified API version in JSON format.

Get lifecycle settings

Tool to get the published status for the specified API and version.

Get Organization Members

Tool to retrieve a list of organization members and their roles from SwaggerHub.

Get User Organizations

Tool to get organizations for a user.

Get Organization Projects V2

Tool to get all projects of an organization in SwaggerHub.

Get Owner APIs

Tool to get a list of APIs for a specified owner in SwaggerHub.

Get owner domains

Tool to retrieve domains owned by a specific SwaggerHub user or organization.

Get Portal

Tool to retrieve information about a portal.

Get Portal Access Requests

Tool to retrieve access requests for a portal in SwaggerHub.

Get Portal Attachment

Tool to get informational attachment metadata from SwaggerHub Portal.

Get Portal Product

Tool to retrieve detailed information about a specific product resource.

Get Portal Products

Tool to get products for a specific portal that match your criteria.

Get Portals

Tool to search for available portals.

Get Portal Templates

Tool to get templates for a specific portal that match your criteria.

Get API Version Private Settings

Tool to get the visibility (public or private) of an API version.

List Resource Types and Roles

Tool to list available resource types and assignable roles for each in a SwaggerHub organization.

Get Templates

Tool to retrieve a list of templates for an owner in SwaggerHub.

Get User Roles

Tool to retrieve all roles assigned to a user across organization resources in SwaggerHub.

Get YAML API Definition

Tool to download OpenAPI definition as a YAML file from SwaggerHub Portal API.

Get YAML Definition

Tool to get the OpenAPI definition in YAML format for the specified API version from SwaggerHub.

List Attachments

Tool to retrieve all attachments for a portal or product.

Remove Access Control for Teams

Tool to remove access control for teams from a SwaggerHub resource.

Remove Access Control For Users

Tool to remove access control for users from a SwaggerHub organizational resource.

Remove Organization Members

Tool to remove members from a SwaggerHub organization.

Search APIs

Tool to search SwaggerHub APIs.

Search APIs and Domains

Tool to search SwaggerHub APIs, domains, and templates.

Search Domains

Tool to search SwaggerHub domains.

Search Published Portal

Tool to search published portal content.

Update Access Control for Teams

Tool to update access control roles for teams on a SwaggerHub resource.

Update Access Control for Users

Tool to update access control roles for users on a SwaggerHub resource.

Update Access Control for Teams

Tool to update access control for teams on a SwaggerHub resource.

Update Access Control Users

Tool to update access control roles for users on a SwaggerHub resource.

Update Portal

Tool to update specific portal information in SwaggerHub.

FAQ

Frequently asked questions

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

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

Start with Swaggerhub.It takes 30 seconds.

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

Start building