How to integrate Ably MCP with OpenAI Agents SDK

This guide walks you through connecting Ably to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Ably agent that can list all active channels and their details, get message history from 'support-chat' channel, show presence history for 'live-event' channel through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Ably account through Composio's Ably MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Ably logoAbly
Api Key

Ably is a real-time messaging platform for live chat and data sync in modern apps. It offers global scale and rock-solid reliability for seamless, instant experiences.

25 Tools

Introduction

This guide walks you through connecting Ably to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Ably agent that can list all active channels and their details, get message history from 'support-chat' channel, show presence history for 'live-event' channel through natural language commands.

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

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

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

The Ably MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Ably account. It provides structured and secure access to your real-time messaging infrastructure, so your agent can manage channels, monitor presence, analyze usage, and handle messaging workflows for your applications.

  • Channel management and creation: Seamlessly create, initialize, or retrieve real-time messaging channels so your agent can orchestrate chat, data sync, and collaboration features on demand.
  • Presence tracking and analytics: Ask your agent to query current presence states or review historical presence data across multiple channels, gaining insights into user activity and engagement patterns.
  • Message history and audit: Retrieve detailed message histories from any channel, enabling your agent to audit communication, recover missed messages, or analyze message flows for debugging and compliance.
  • Push notification subscription management: Let your agent list, manage, or unsubscribe devices from push notification channels, ensuring targeted and controlled delivery of real-time alerts to clients.
  • Application statistics and monitoring: Have your agent fetch in-depth usage metrics—like message counts, channel activity, and API request stats—so you can monitor health, optimize performance, and manage resources with confidence.

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

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

Query Batch Presence

This tool enables querying the presence states of multiple channels in a single API request.

Query Batch Presence History

This tool enables querying presence history for multiple channels in a single API request.

Delete Channel Subscription

This tool allows you to unsubscribe devices or clients from push notifications for specific channels.

Get Channel Details

This tool retrieves metadata and details for a specific channel in Ably.

Get Channel History

This tool retrieves the message history for a specified Ably channel.

Get Channel Presence

Tool to obtain the set of members currently present for a channel.

Get Message Versions

Tool to retrieve all historical versions of a specific message from an Ably channel.

Get Channel Presence History

This tool retrieves the history of presence messages for a specified channel in Ably.

Get Push Device Registration

Tool to get the full details of a device registration for push notifications.

Get Ably Service Time

This tool retrieves the current server time from Ably's service in milliseconds since the epoch.

Get Application Stats

This tool retrieves your application's usage statistics from Ably.

List Channels

Tool to enumerate all active channels in the Ably application.

List Push Channels

Tool to list all channels with at least one subscribed device.

List Push Channel Subscriptions

This tool retrieves a list of all push notification channel subscriptions.

List Registered Push Devices

Tool to list all devices registered for receiving push notifications in your Ably application.

Patch Push Device Registration

Tool to partially update specific attributes of an existing device registration in Ably's push notification system.

Batch Publish Messages

Tool to batch publish messages to multiple channels in parallel.

Publish Message to Channel

This tool will allow users to publish a message to a specified Ably channel using a POST request.

Publish Push Notification

Tool to publish a push notification directly to device(s) via Ably's Push Notifications API.

Batch Publish Push Notifications

Tool to batch publish push notifications directly to specific recipients.

Register Push Device

Tool to register a device for receiving push notifications in Ably.

Request Access Token

Request an access token for Ably authentication.

Unregister All Push Devices

Tool to unregister matching devices for push notifications.

Unregister Push Device

Tool to unregister a single device from push notifications in Ably.

Update Push Device Registration

Tool to update (upsert) a device registration for push notifications in Ably.

FAQ

Frequently asked questions

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

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

Start with Ably.It takes 30 seconds.

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

Start building