How to integrate Roam MCP with Claude Agent SDK

This guide walks you through connecting Roam to the Claude Agent 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 Claude Agent 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.

Get started for freeGet a demo
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 Claude Agent 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 Claude Agent 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

OpenAI Agents SDKClaude CodeClaude CoworkCodexOpenClawHermesCLIGoogle ADKLangChainVercel AI SDKMastra AILlamaIndexCrewAI

TL;DR

Here's what you'll learn:
  • Get and set up your Claude/Anthropic 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 Claude Agent SDK?

The Claude Agent SDK is Anthropic's official framework for building AI agents powered by Claude. It provides a streamlined interface for creating agents with MCP tool support and conversation management.

Key features include:

  • Native MCP Support: Built-in support for Model Context Protocol servers
  • Permission Modes: Control tool execution permissions
  • Streaming Responses: Real-time response streaming for interactive applications
  • Context Manager: Clean async context management for sessions

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 Claude/Anthropic API Key
  • Primary know-how of Claude Agents SDK
  • A Roam account
  • Some knowledge of Python
2

Getting API Keys for Claude/Anthropic and Composio

Claude/Anthropic API Key
  • Go to the Anthropic Console and create an API key. You'll need credits to use the models.
  • Keep the API key safe.
Composio API Key
  • Log in to the Composio dashboard.
  • Navigate to your API settings and generate a new API key.
  • Store this key securely as you'll need it for authentication.
3

Install dependencies

npm install @anthropic-ai/claude-agent-sdk @composio/core dotenv

Install the Composio SDK and the Claude Agents SDK.

What's happening:

  • @composio/core provides Composio integration for Anthropic
  • @anthropic-ai/claude-agent-sdk is the core agent framework
  • dotenv/config loads environment variables
4

Set up environment variables

bash
COMPOSIO_API_KEY=your_composio_api_key_here
USER_ID=your_user_id_here
ANTHROPIC_API_KEY=your_anthropic_api_key_here

Create a .env file in your project root.

What's happening:

  • COMPOSIO_API_KEY authenticates with Composio
  • USER_ID identifies the user for session management
  • ANTHROPIC_API_KEY authenticates with Anthropic/Claude
5

Import dependencies

import 'dotenv/config';
import readline from 'node:readline';
import { Composio } from '@composio/core';
import { query, type Options } from "@anthropic-ai/claude-agent-sdk";

dotenv.config();
What's happening:
  • We're importing all necessary libraries including the Claude Agent SDK and Composio
  • The dotenv.config() function loads environment variables from your .env file
  • This setup prepares the foundation for connecting Claude with Roam functionality
6

Create a Composio instance and Tool Router session

async function chat() {
  const { COMPOSIO_API_KEY, USER_ID } = process.env;
  if (!COMPOSIO_API_KEY || !USER_ID) {
    throw new Error('COMPOSIO_API_KEY and USER_ID required in .env');
  }

  const composio = new Composio({ apiKey: COMPOSIO_API_KEY });

  // Create Tool Router session for Roam
  const session = await composio.create(USER_ID, {
    toolkits: ['roam'],
  });
  const mcpUrl = session?.mcp.url;
What's happening:
  • The function checks for the required COMPOSIO_API_KEY environment variable
  • We're creating a Composio instance using our API key
  • The create method creates a Tool Router session for Roam
  • The returned url is the MCP server URL that your agent will use
7

Configure Claude Agent with MCP

const options: Options = {
  permissionMode: 'bypassPermissions',
  mcpServers: {
    composio: {
      type: 'http',
      url: mcpUrl,
      headers: { 'x-api-key': COMPOSIO_API_KEY }
    }
  },
  systemPrompt: 'You are a helpful assistant with access to Roam tools via Composio.',
  maxTurns: 10,
};
What's happening:
  • We're configuring the Claude Agent options with the MCP server URL
  • permissionMode: 'bypassPermissions' allows the agent to execute operations without asking for permission each time
  • The system prompt instructs the agent that it has access to Roam
  • maxTurns: 10 limits the conversation length to prevent excessive API usage
8

Create client and start chat loop

const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: 'You: '
  });

  console.log('\nChat started. Type "exit" to quit.\n');

  let isProcessing = false;

  async function ask(prompt: string) {
    isProcessing = true;
    rl.pause();

    process.stdout.write('Claude is thinking...');
    const stream = query({ prompt, options });

    let firstChunk = true;
    for await (const msg of stream) {
      const content = (msg as any).message?.content || (msg as any).content;
      if (Array.isArray(content)) {
        for (const block of content) {
          if (block.type === 'text' && block.text) {
            if (firstChunk) {
              process.stdout.write('\r\x1b[K');
              process.stdout.write('Claude: ');
              firstChunk = false;
            }
            process.stdout.write(block.text);
          }
        }
      }
    }
    process.stdout.write('\n\n');

    isProcessing = false;
    rl.resume();
    rl.prompt();
  }

  rl.on('line', async (line) => {
    if (isProcessing) return;

    const input = line.trim();
    if (input === 'exit') {
      rl.close();
      process.exit(0);
    }
    if (input) await ask(input);
    else rl.prompt();
  });

  await ask('What can you help me with?');
}
What's happening:
  • The readline interface is created to handle user input and output
  • The query function is used to send the user's input to the agent
  • The chat loop continues until the user types 'exit' or 'quit'
9

Run the application

try {
  await chat();
} catch (error) {
  console.error(error);
  process.exit(1);
}
What's happening:
  • The chat function is the entry point for the application
  • The try-catch block is used to handle any errors that occur

Complete Code

Here's the complete code to get you started with Roam and Claude Agent SDK:

import 'dotenv/config';
import readline from 'node:readline';
import { Composio } from '@composio/core';
import { query, type Options } from "@anthropic-ai/claude-agent-sdk";

async function chat() {
  const { COMPOSIO_API_KEY, USER_ID } = process.env;
  if (!COMPOSIO_API_KEY || !USER_ID) {
    throw new Error('COMPOSIO_API_KEY and USER_ID required in .env');
  }

  const composio = new Composio({ apiKey: COMPOSIO_API_KEY });
  const session = await composio.create(USER_ID, {
    toolkits: ['roam']
  });
  const mcp_url = session?.mcp.url;

  const options: Options = {
    permissionMode: 'bypassPermissions',
    mcpServers: {
      composio: {
        type: 'http',
        url: mcp_url,
        headers: { 'x-api-key': COMPOSIO_API_KEY }
      }
    },
    systemPrompt: 'You are a helpful assistant with access to Roam tools via Composio.',
    maxTurns: 10,
  };

  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: 'You: '
  });

  console.log('\nChat started. Type "exit" to quit.\n');

  let isProcessing = false;

  async function ask(prompt: string) {
    isProcessing = true;
    rl.pause();

    process.stdout.write('Claude is thinking...');
    const stream = query({ prompt, options });

    let firstChunk = true;
    for await (const msg of stream) {
      const content = (msg as any).message?.content || (msg as any).content;
      if (Array.isArray(content)) {
        for (const block of content) {
          if (block.type === 'text' && block.text) {
            if (firstChunk) {
              process.stdout.write('\r\x1b[K');
              process.stdout.write('Claude: ');
              firstChunk = false;
            }
            process.stdout.write(block.text);
          }
        }
      }
    }
    process.stdout.write('\n\n');

    isProcessing = false;
    rl.resume();
    rl.prompt();
  }

  rl.on('line', async (line) => {
    if (isProcessing) return;

    const input = line.trim();
    if (input === 'exit') {
      rl.close();
      process.exit(0);
    }
    if (input) await ask(input);
    else rl.prompt();
  });

  await ask('What can you help me with?');
}

try {
  await chat();
} catch (error) {
  console.error(error);
  process.exit(1);
}

Conclusion

You've successfully built a Claude Agent SDK agent that can interact with Roam through Composio's Tool Router.

Key features:

  • Native MCP support through Claude's agent framework
  • Streaming responses for real-time interaction
  • Permission bypass for smooth automated workflows
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.

FRAMEWORKS

How to build Roam MCP Agent with another framework

OpenAI Agents SDK logo

OpenAI Agents SDK

Use Roam MCP with OpenAI Agents SDK

Claude Code logo

Claude Code

Use Roam MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use Roam MCP with Claude Cowork

Codex logo

Codex

Use Roam MCP with Codex

OpenClaw logo

OpenClaw

Use Roam MCP with OpenClaw

Hermes logo

Hermes

Use Roam MCP with Hermes

CLI logo

CLI

Use Roam MCP with CLI

Google ADK logo

Google ADK

Use Roam MCP with Google ADK

LangChain logo

LangChain

Use Roam MCP with LangChain

Vercel AI SDK logo

Vercel AI SDK

Use Roam MCP with Vercel AI SDK

Mastra AI logo

Mastra AI

Use Roam MCP with Mastra AI

LlamaIndex logo

LlamaIndex

Use Roam MCP with LlamaIndex

CrewAI logo

CrewAI

Use Roam MCP with CrewAI

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. Claude Agent 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
Customer stories

Teams ship real agents on Composio

GET STARTED FOR FREEBOOK A DEMO
agent.aiZoomLettaGleanHubSpotAWSWabi

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

Harsha Gaddipati
Harsha Gaddipati
Co-founder, Slashy

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's immensely helped keep new users on the platform.

Abhi Arya
Abhi Arya
Co-founder, Opennote

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

Nirman Dave
Nirman Dave
CEO, Zams

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

Ryan Yu
Ryan Yu
Founder, Extra Thursday

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

Tomisin Jenrola
Tomisin Jenrola
Founder & CEO, SwarmZero

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.

Jerome Leclanche
Jerome Leclanche
Co-Founder, Ingram Technologies