How to integrate Roam MCP with Claude Code

Manage your Roam directly from Claude Code with zero worries about OAuth hassles, API-breaking issues, or reliability and security concerns. You can do this in two different ways: Via Composio Connect - Direct and easiest approach Via Composio SDK - Programmatic approach with more control

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

Manage your Roam directly from Claude Code with zero worries about OAuth hassles, API-breaking issues, or reliability and security concerns.

You can do this in two different ways:

  1. Via Composio Connect - Direct and easiest approach
  2. Via Composio SDK - Programmatic approach with more control

Also integrate Roam with

Why use Composio?

  • Only one MCP URL to connect multiple apps with Claude Code with zero auth hassles.
  • Programmatic tool calling allows LLMs to write its code in a remote workbench to handle complex tool chaining. Reduces to-and-fro with LLMs for frequent tool calling.
  • Handling Large tool responses out of LLM context to minimize context rot.
  • Dynamic just-in-time access to 20,000 tools across 1000+ other Apps for cross-app workflows. It loads the tools you need, so LLMs aren't overwhelmed by tools you don't need.

Connecting Roam to Claude Code using Composio

1. Add the Composio MCP to Claude

Terminal

2. Start Claude Code

bash
claude

3. Open your MCP list

bash
/mcp

4. Select Composio and click on Authenticate

Select Composio and click Authenticate

5. This will redirect you to the Composio OAuth page. Complete the flow by authorizing Composio and you're all set.

Composio OAuth authorization page
Composio authorization complete
Ask Claude to connect to your account and authenticate via the link

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.

Connecting Roam via Composio SDK

Composio SDK is the underlying tech that powers Rube. It's a universal gateway that does everything Rube does but with much more programmatic control. You can programmatically generate an MCP URL with the app you need (here Roam) for even more tool search precision. It's secure and reliable.

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 step10 STEPS
1

Prerequisites

Before starting, make sure you have:
  • Claude Pro, Max, or API billing enabled Anthropic account
  • Composio API Key
  • A Roam account
  • Basic knowledge of Python or TypeScript
2

Install Claude Code

bash
# macOS, Linux, WSL
curl -fsSL https://claude.ai/install.sh | bash

# Windows PowerShell
irm https://claude.ai/install.ps1 | iex

# Windows CMD
curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd

To install Claude Code, use one of the following methods based on your operating system:

3

Set up Claude Code

bash
cd your-project-folder
claude

Open a terminal, go to your project folder, and start Claude Code:

  • Claude Code will open in your terminal
  • Follow the prompts to sign in with your Anthropic account
  • Complete the authentication flow
  • Once authenticated, you can start using Claude Code
Claude Code initial setup showing sign-in prompt
Claude Code terminal after successful login
4

Set up environment variables

bash
COMPOSIO_API_KEY=your_composio_api_key_here
USER_ID=your_user_id_here

Create a .env file in your project root with the following variables:

  • COMPOSIO_API_KEY authenticates with Composio (get it from Composio dashboard)
  • USER_ID identifies the user for session management (use any unique identifier)
5

Install Composio library

npm install @composio/core dotenv

Install the Composio TypeScript library to create MCP sessions.

  • @composio/core provides the core Composio functionality
  • dotenv loads environment variables from your .env file
6

Generate Composio MCP URL

import 'dotenv/config';
import { Composio } from '@composio/core';

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 composioClient = new Composio({ apiKey: COMPOSIO_API_KEY });

const composioSession = await composioClient.create(USER_ID, {
  toolkits: ['roam'],
});

const composioMcpUrl = composioSession?.mcp.url;

console.log(`MCP URL: ${composioMcpUrl}`);
console.log(`\nUse this command to add to Claude Code:`);
console.log(`claude mcp add --transport http roam-composio "${composioMcpUrl}" --headers "X-API-Key:${COMPOSIO_API_KEY}"`);

Create a script to generate a Composio MCP URL for Roam. This URL will be used to connect Claude Code to Roam.

What's happening

  • We import the Composio client and load environment variables
  • Create a Composio instance with your API key
  • Call create() to create a Tool Router session for Roam
  • The returned mcp.url is the MCP server URL that Claude Code will use
  • The script prints this URL so you can copy it
7

Run the script and copy the MCP URL

node --loader ts-node/esm generate_mcp_url.ts
# or if using tsx
tsx generate_mcp_url.ts

Run your TypeScript script to generate the MCP URL.

  • The script connects to Composio and creates a Tool Router session
  • It prints the MCP URL and the exact command you need to run
  • Copy the entire claude mcp add command from the output
8

Add Roam MCP to Claude Code

bash
claude mcp add --transport http roam-composio "YOUR_MCP_URL_HERE" --headers "X-API-Key:YOUR_COMPOSIO_API_KEY"

# Then restart Claude Code
exit
claude

In your terminal, add the MCP server using the command from the previous step. The command format is:

  • claude mcp add registers a new MCP server with Claude Code
  • --transport http specifies that this is an HTTP-based MCP server
  • The server name (roam-composio) is how you'll reference it
  • The URL points to your Composio Tool Router session
  • --headers includes your Composio API key for authentication

After running the command, close the current Claude Code session and start a new one for the changes to take effect.

9

Verify the installation

bash
claude mcp list

Check that your Roam MCP server is properly configured.

  • This command lists all MCP servers registered with Claude Code
  • You should see your roam-composio entry in the list
  • This confirms that Claude Code can now access Roam tools

If everything is wired up, you should see your roam-composio entry listed:

Claude Code MCP list showing the toolkit MCP server
10

Authenticate Roam

The first time you try to use Roam tools, you'll be prompted to authenticate.

  • Claude Code will detect that you need to authenticate with Roam
  • It will show you an authentication link
  • Open the link in your browser (or copy/paste it)
  • Complete the Roam authorization flow
  • Return to the terminal and start using Roam through Claude Code

Once authenticated, you can ask Claude Code to perform Roam operations in natural language. For example:

  • "Summarize unread Roam team messages"
  • "Send secure file to compliance channel"
  • "Find recent chats about incident response"

Complete Code

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

import 'dotenv/config';
import { Composio } from '@composio/core';

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 composioClient = new Composio({ apiKey: COMPOSIO_API_KEY });

const composioSession = await composioClient.create(USER_ID, {
  toolkits: ['roam'],
});

const composioMcpUrl = composioSession?.mcp.url;

console.log(`MCP URL: ${composioMcpUrl}`);
console.log(`\nUse this command to add to Claude Code:`);
console.log(`claude mcp add --transport http roam-composio "${composioMcpUrl}" --headers "X-API-Key:${COMPOSIO_API_KEY}"`);

Conclusion

You've successfully integrated Roam with Claude Code using Composio's MCP server. Now you can interact with Roam directly from your terminal using natural language commands.

Key features of this setup:

  • Terminal-native experience without switching contexts
  • Natural language commands for Roam operations
  • Secure authentication through Composio's managed MCP
  • Tool Router for dynamic tool discovery and execution

Next steps:

  • Try asking Claude Code to perform various Roam operations
  • Add more toolkits to your Tool Router session for multi-app workflows
  • Integrate this setup into your development workflow for increased productivity

You can extend this by adding more toolkits, implementing custom workflows, or building automation scripts that leverage Claude Code's capabilities.

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. Claude Code 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