How to integrate Roam MCP with OpenAI Agents SDK

This guide walks you through connecting Roam to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Roam agent that can summarize unread roam team messages, send secure file to compliance channel, find recent chats about incident response through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Roam account through Composio's Roam MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Roam logoRoam
Api KeyOauth2

Roam HQ is a secure messaging, chat, file sharing, and collaboration platform. It helps teams communicate with enterprise-grade security and compliance controls.

39 Tools

Introduction

This guide walks you through connecting Roam to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Roam agent that can summarize unread roam team messages, send secure file to compliance channel, find recent chats about incident response through natural language commands.

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

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

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

The Roam MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Roam account. It provides structured and secure access to your chats, messages, shared files, meeting links, and directory information, so your agent can post to chats, message groups, upload files, retrieve meeting links, and look up chat participants on your behalf.

  • Chat messaging: Have your agent post updates, announcements, or replies directly to a Roam chat.
  • Group communication: Direct your agent to send a message to selected recipients for team coordination and follow-ups.
  • File sharing: Let the agent upload a file to Roam so it can be shared as a chat attachment.
  • Meeting access: Instruct your agent to retrieve a Roam meeting link when you need to join or share a conversation.
  • Directory and schema lookup: Have your agent look up information about chat participants or retrieve a specific SCIM schema definition.

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

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

Add group members

Add one or more group members and/or admins to an existing Roam group.

Add Reaction to Message

Add an emoji reaction to a message in a chat.

Create Group

Create a group address that can be used for chat.

Create Roam SCIM Group

Tool to create a new group in your Roam organization using SCIM 2.

Create Roam User

Create a new user in Roam via SCIM 2.

Delete Roam Group

Archive a group in Roam using SCIM 2.

Delete Roam User

Archive a user in Roam using SCIM 2.

Get Address Info

Get information about a chat address, which is the name for any entity that may participate in a chat, such as a user, visitor, or bot.

Get chat history

Lists messages in a chat, filtered by date range (after/before).

Get meeting link

Tool to get a meeting link.

Get Roam SCIM Resource Types

Returns the list of SCIM 2.

Get SCIM service provider config

Tool to retrieve Roam's SCIM service provider configuration.

Get SCIM schema

Retrieves the definition of a specific SCIM 2.

Get user by ID (SCIM)

Tool to retrieve a single user by their Roam Person ID using SCIM 2.

Test API Connectivity

Test endpoint for API connectivity.

Get token info

Retrieves information about the current Roam access token.

Get user info

Get detailed information about a single user in your Roam workspace.

List Roam Chats

Lists all accessible chats, which consist of all DMs, MultiDMs, and Channels that your bot has been added to, in addition to all public channels.

List group members

List members in a group in your Roam workspace.

List SCIM Groups

Returns a paginated list of groups in your Roam organization via SCIM 2.

List Roam Lobbies

Lists active lobbies in your Roam account.

List Roam Meetings

Lists all meetings in your home Roam, filtered by date range.

List Roam Recordings

Tool to list all recordings in your home Roam.

List users (SCIM)

Tool to list users in your Roam organization using SCIM 2.

List SCIM Schemas

Tool to list all SCIM 2.

List Roam Transcripts

Lists all transcripts in your Roam workspace, filtered by date range.

List User Audit Log

Tool to get a list of user audit log entries for the account.

List Users

Tool to list all users in the Roam workspace.

Lookup user by email

Look up a user in your Roam workspace by their email address.

Patch a group

Partially updates a group using SCIM 2.

Patch user (SCIM)

Partially updates a user using SCIM 2.

Post message to chat

Post a message to a chat.

Remove group members

Tool to remove one or more members from a group in your Roam workspace.

Replace Roam SCIM Group

Fully replaces a group's attributes using SCIM 2.

Replace Roam User

Fully replaces (updates) a user's attributes in Roam via SCIM 2.

Send message to group

Sends the given message to the specified recipients.

Send Typing Indicator

Tool to notify other chat participants that you are typing.

Update a meeting link

Update settings for an existing meeting link in Roam.

Upload File to Roam

Upload a file to Roam so it can be sent as a chat attachment.

FAQ

Frequently asked questions

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

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

Start with Roam.It takes 30 seconds.

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

Start building