How to integrate Roam MCP with Mastra AI

This guide walks you through connecting Roam to Mastra AI 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 Mastra AI 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 free Get a demo

Roam

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

Managed auth

Connect Roam without auth hassles

We manage OAuth, API keys, token refresh, and scopes — you just build.

Try for free

Introduction

This guide will help you understand how to give your Mastra AI 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 SDK Claude Agent SDK Claude Code Claude Cowork Codex OpenClaw Hermes CLI Google ADK LangChain Vercel AI SDK LlamaIndex CrewAI

TL;DR

Here's what you'll learn:

Set up your environment so Mastra, OpenAI, and Composio work together
Create a Tool Router session in Composio that exposes Roam tools
Connect Mastra's MCP client to the Composio generated MCP URL
Fetch Roam tool definitions and attach them as a toolset
Build a Mastra agent that can reason, call tools, and return structured results
Run an interactive CLI where you can chat with your Roam agent

What is Mastra AI?

Mastra AI is a TypeScript framework for building AI agents with tool support. It provides a clean API for creating agents that can use external services through MCP.

Key features include:

MCP Client: Built-in support for Model Context Protocol servers
Toolsets: Organize tools into logical groups
Step Callbacks: Monitor and debug agent execution
OpenAI Integration: Works with OpenAI models via @ai-sdk/openai

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:

Discovery: Searches for tools matching your task and returns relevant toolkits with their details.
Authentication: Checks for active connections. If missing, creates an auth config and returns a connection URL via Auth Link.
Execution: Executes the action using the authenticated connection.

Step-by-step Guide

Step by step09 STEPS

Prerequisites

Before starting, make sure you have:

Node.js 18 or higher
A Composio account with an active API key
An OpenAI API key
Basic familiarity with TypeScript

Getting API Keys for OpenAI and Composio

OpenAI API Key

Go to the OpenAI dashboard and create an API key.
You need credits or a connected billing setup to use the models.
Store the key somewhere safe.

Composio API Key

Log in to the Composio dashboard.
Go to Settings and copy your API key.
This key lets your Mastra agent talk to Composio and reach Roam through MCP.

Install dependencies

bash

npm install @composio/core @mastra/core @mastra/mcp @ai-sdk/openai dotenv

Install the required packages.

What's happening:

@composio/core is the Composio SDK for creating MCP sessions
@mastra/core provides the Agent class
@mastra/mcp is Mastra's MCP client
@ai-sdk/openai is the model wrapper for OpenAI
dotenv loads environment variables from .env

Set up environment variables

bash

COMPOSIO_API_KEY=your_composio_api_key_here
COMPOSIO_USER_ID=your_user_id_here
OPENAI_API_KEY=your_openai_api_key_here

Create a .env file in your project root.

What's happening:

COMPOSIO_API_KEY authenticates your requests to Composio
COMPOSIO_USER_ID tells Composio which user this session belongs to
OPENAI_API_KEY lets the Mastra agent call OpenAI models

Import libraries and validate environment

typescript

import "dotenv/config";
import { openai } from "@ai-sdk/openai";
import { Agent } from "@mastra/core/agent";
import { MCPClient } from "@mastra/mcp";
import { Composio } from "@composio/core";
import * as readline from "readline";

import type { AiMessageType } from "@mastra/core/agent";

const openaiAPIKey = process.env.OPENAI_API_KEY;
const composioAPIKey = process.env.COMPOSIO_API_KEY;
const composioUserID = process.env.COMPOSIO_USER_ID;

if (!openaiAPIKey) throw new Error("OPENAI_API_KEY is not set");
if (!composioAPIKey) throw new Error("COMPOSIO_API_KEY is not set");
if (!composioUserID) throw new Error("COMPOSIO_USER_ID is not set");

const composio = new Composio({
  apiKey: composioAPIKey as string,
});

What's happening:

dotenv/config auto loads your .env so process.env.* is available
openai gives you a Mastra compatible model wrapper
Agent is the Mastra agent that will call tools and produce answers
MCPClient connects Mastra to your Composio MCP server
Composio is used to create a Tool Router session

Create a Tool Router session for Roam

typescript

async function main() {
  const session = await composio.create(
    composioUserID as string,
    {
      toolkits: ["roam"],
    },
  );

  const composioMCPUrl = session.mcp.url;
  console.log("Roam MCP URL:", composioMCPUrl);

What's happening:

create spins up a short-lived MCP HTTP endpoint for this user
The toolkits array contains "roam" for Roam access
session.mcp.url is the MCP URL that Mastra's MCPClient will connect to

Configure Mastra MCP client and fetch tools

typescript

const mcpClient = new MCPClient({
    id: composioUserID as string,
    servers: {
      nasdaq: {
        url: new URL(composioMCPUrl),
        requestInit: {
          headers: session.mcp.headers,
        },
      },
    },
    timeout: 30_000,
  });

console.log("Fetching MCP tools from Composio...");
const composioTools = await mcpClient.getTools();
console.log("Number of tools:", Object.keys(composioTools).length);

What's happening:

MCPClient takes an id for this client and a list of MCP servers
The headers property includes the x-api-key for authentication
getTools fetches the tool definitions exposed by the Roam toolkit

Create the Mastra agent

typescript

const agent = new Agent({
    name: "roam-mastra-agent",
    instructions: "You are an AI agent with Roam tools via Composio.",
    model: "openai/gpt-5",
  });

What's happening:

Agent is the core Mastra agent
name is just an identifier for logging and debugging
instructions guide the agent to use tools instead of only answering in natural language
model uses openai("gpt-5") to configure the underlying LLM

Set up interactive chat interface

typescript

let messages: AiMessageType[] = [];

console.log("Chat started! Type 'exit' or 'quit' to end.\n");

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

rl.prompt();

rl.on("line", async (userInput: string) => {
  const trimmedInput = userInput.trim();

  if (["exit", "quit", "bye"].includes(trimmedInput.toLowerCase())) {
    console.log("\nGoodbye!");
    rl.close();
    process.exit(0);
  }

  if (!trimmedInput) {
    rl.prompt();
    return;
  }

  messages.push({
    id: crypto.randomUUID(),
    role: "user",
    content: trimmedInput,
  });

  console.log("\nAgent is thinking...\n");

  try {
    const response = await agent.generate(messages, {
      toolsets: {
        roam: composioTools,
      },
      maxSteps: 8,
    });

    const { text } = response;

    if (text && text.trim().length > 0) {
      console.log(`Agent: ${text}\n`);
        messages.push({
          id: crypto.randomUUID(),
          role: "assistant",
          content: text,
        });
      }
    } catch (error) {
      console.error("\nError:", error);
    }

    rl.prompt();
  });

  rl.on("close", async () => {
    console.log("\nSession ended.");
    await mcpClient.disconnect();
    process.exit(0);
  });
}

main().catch((err) => {
  console.error("Fatal error:", err);
  process.exit(1);
});

What's happening:

messages keeps the full conversation history in Mastra's expected format
agent.generate runs the agent with conversation history and Roam toolsets
maxSteps limits how many tool calls the agent can take in a single run
onStepFinish is a hook that prints intermediate steps for debugging

Complete Code

Here's the complete code to get you started with Roam and Mastra AI:

typescript

import "dotenv/config";
import { openai } from "@ai-sdk/openai";
import { Agent } from "@mastra/core/agent";
import { MCPClient } from "@mastra/mcp";
import { Composio } from "@composio/core";
import * as readline from "readline";

import type { AiMessageType } from "@mastra/core/agent";

const openaiAPIKey = process.env.OPENAI_API_KEY;
const composioAPIKey = process.env.COMPOSIO_API_KEY;
const composioUserID = process.env.COMPOSIO_USER_ID;

if (!openaiAPIKey) throw new Error("OPENAI_API_KEY is not set");
if (!composioAPIKey) throw new Error("COMPOSIO_API_KEY is not set");
if (!composioUserID) throw new Error("COMPOSIO_USER_ID is not set");

const composio = new Composio({ apiKey: composioAPIKey as string });

async function main() {
  const session = await composio.create(composioUserID as string, {
    toolkits: ["roam"],
  });

  const composioMCPUrl = session.mcp.url;

  const mcpClient = new MCPClient({
    id: composioUserID as string,
    servers: {
      roam: {
        url: new URL(composioMCPUrl),
        requestInit: {
          headers: session.mcp.headers,
        },
      },
    },
    timeout: 30_000,
  });

  const composioTools = await mcpClient.getTools();

  const agent = new Agent({
    name: "roam-mastra-agent",
    instructions: "You are an AI agent with Roam tools via Composio.",
    model: "openai/gpt-5",
  });

  let messages: AiMessageType[] = [];

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

  rl.prompt();

  rl.on("line", async (input: string) => {
    const trimmed = input.trim();
    if (["exit", "quit"].includes(trimmed.toLowerCase())) {
      rl.close();
      return;
    }

    messages.push({ id: crypto.randomUUID(), role: "user", content: trimmed });

    const { text } = await agent.generate(messages, {
      toolsets: { roam: composioTools },
      maxSteps: 8,
    });

    if (text) {
      console.log(`Agent: ${text}\n`);
      messages.push({ id: crypto.randomUUID(), role: "assistant", content: text });
    }

    rl.prompt();
  });

  rl.on("close", async () => {
    await mcpClient.disconnect();
    process.exit(0);
  });
}

main();

Conclusion

You've built a Mastra AI agent that can interact with Roam through Composio's Tool Router. You can extend this further by:

Adding other toolkits like Gmail, Slack, or GitHub
Building a web-based chat interface around this agent
Using multiple MCP endpoints to enable cross-app workflows

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

Use Roam MCP with OpenAI Agents SDK

Claude Agent SDK

Use Roam MCP with Claude Agent SDK

Claude Code

Use Roam MCP with Claude Code

Claude Cowork

Use Roam MCP with Claude Cowork

Codex

Use Roam MCP with Codex

OpenClaw

Use Roam MCP with OpenClaw

Hermes

Use Roam MCP with Hermes

CLI

Use Roam MCP with CLI

Google ADK

Use Roam MCP with Google ADK

LangChain

Use Roam MCP with LangChain

Vercel AI SDK

Use Roam MCP with Vercel AI SDK

LlamaIndex

Use Roam MCP with LlamaIndex

CrewAI

Use Roam MCP with CrewAI

MORE TOOLKITS

Explore Other Toolkits

Toolkit marketplace

Agent mail

Api Key

Agent mail provides AI agents with dedicated email inboxes for sending, receiving, and managing emails. It empowers agents to communicate autonomously with people, services, and other agents—no human intervention needed.

Blooio

Api Key

Blooio is a stable v2 API platform for messaging, chats, contacts, groups, phone numbers, and account analytics. It gives teams a clean way to build reliable communication workflows without stitching together fragile custom APIs.

CardClan

Api Key

CardClan is a digital card platform for creating and sending personalized team cards. Use it to celebrate moments, share card links, and manage card workflows without extra coordination.

Clickmeeting

Api Key

ClickMeeting is a cloud-based platform for running online meetings and webinars. It helps businesses and individuals host, manage, and engage virtual audiences with ease.

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. Mastra AI 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 FREE BOOK A DEMO

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

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

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

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

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

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

Co-Founder, Ingram Technologies

How to integrate Roam MCP with Mastra AI

Connect Roam without auth hassles

Introduction

Also integrate Roam with

TL;DR

What is Mastra AI?

What is the Roam MCP server, and what's possible with it?

What is the Composio tool router, and how does it fit here?

What is Composio SDK?

How the Composio SDK works

Step-by-step Guide

Prerequisites

Getting API Keys for OpenAI and Composio

Install dependencies

Set up environment variables

Import libraries and validate environment

Create a Tool Router session for Roam

Configure Mastra MCP client and fetch tools

Create the Mastra agent

Set up interactive chat interface

Complete Code

Conclusion

Supported Tools

How to build Roam MCP Agent with another framework

OpenAI Agents SDK

Claude Agent SDK

Claude Code

Claude Cowork

Codex

OpenClaw

Hermes

CLI

Google ADK

LangChain

Vercel AI SDK

LlamaIndex

CrewAI

Explore Other Toolkits

Agent mail

Blooio

CardClan

Clickmeeting

Frequently asked questions

What are the differences in Tool Router MCP and Roam MCP?+

Can I use Tool Router MCP with Mastra AI?+

Can I manage the permissions and scopes for Roam while using Tool Router?+

How safe is my data with Composio Tool Router?+

Start with Roam.It takes 30 seconds.

Teams ship real agents on Composio