How to integrate Revolt MCP with OpenAI Agents SDK

This guide walks you through connecting Revolt to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Revolt agent that can fetch profile details for user by id, list all flags assigned to this user, update your status message to 'in a meeting' through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Revolt account through Composio's Revolt MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Revolt logoRevolt
Api Key

Revolt is a free, open-source chat platform for secure, customizable group and 1:1 messaging. Enjoy privacy-first conversations and seamless team collaboration without vendor lock-in.

26 Tools

Introduction

This guide walks you through connecting Revolt to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Revolt agent that can fetch profile details for user by id, list all flags assigned to this user, update your status message to 'in a meeting' through natural language commands.

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

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

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

The Revolt MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Revolt account. It provides structured and secure access to your chat platform, so your agent can perform actions like retrieving user details, inspecting special user flags, and updating user profiles on your behalf.

  • User profile retrieval: Instantly fetch detailed information about any user by providing a valid user ID, making it easy to manage accounts and view profile data.
  • User flag inspection: Allow your agent to access and display special flags or roles associated with specific users, helping you understand permissions or statuses at a glance.
  • User profile updates: Quickly update a user's profile or status fields directly from your agent, streamlining administrative and personalization tasks.
  • Automated user management: Enable your agent to handle user account lookups and modifications, reducing manual effort and improving efficiency in managing your Revolt community.

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

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

Acknowledge Policy Changes

Tool to acknowledge platform policy changes.

Add Reaction to Message

Tool to add a reaction to a message in a channel.

Block User

Tool to block another user by their ID.

Create Sync Settings

Tool to upload and save settings data to Revolt's sync storage.

Delete Message

Tool to delete a message you've sent or one you have permission to delete.

Bulk Delete Messages

Tool to bulk delete multiple messages from a channel.

Fetch Owned Bots

Tool to fetch all bots that you have control over.

Fetch Sync Settings

Tool to fetch settings from server filtered by keys.

Fetch user

Tool to fetch detailed information about a user.

Fetch User Flags

Tool to fetch flags associated with a specific user.

Get API Info

Tool to fetch the server configuration for this Revolt instance.

Get Channel

Tool to fetch a channel by its ID.

Get Current User

Tool to retrieve your own user information.

Get Invite

Tool to fetch detailed information about an invite by its code.

Get Sync Unreads

Tool to fetch information about unread state on channels.

Get User Profile

Tool to retrieve a user's profile data including bio and background.

Get User's Default Avatar

Tool to fetch a user's default avatar image based on their ID.

Open DM with User

Tool to open a DM with another user.

Get User DMs

Tool to fetch all direct message conversations for the authenticated user.

Pin Message

Tool to pin a message in a channel by its ID.

Remove Message Reaction

Tool to remove a reaction from a message.

Send Channel Message

Tool to send a message to a Revolt channel.

Unblock User

Tool to unblock another user by their ID.

Unpin Message

Tool to unpin a message in a channel.

Update Channel Message

Tool to edit a message that you've previously sent in a channel.

Update User

Tool to update user information.

FAQ

Frequently asked questions

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

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

Start with Revolt.It takes 30 seconds.

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

Start building