How to integrate Miro MCP with OpenAI Agents SDK

This guide walks you through connecting Miro to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Miro agent that can create a new board for marketing brainstorm, list all boards owned by your team, show members of the q2 planning board through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Miro account through Composio's Miro 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

Miro

Oauth2

Miro is a collaborative online whiteboard platform for teams to brainstorm, design, and manage projects visually. It streamlines teamwork by enabling real-time idea sharing, diagramming, and workflow planning in a single space.

73 Tools

Managed auth

Connect Miro 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 OpenAI Agents SDK agent real control over a Miro account through Composio's Miro MCP server.

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

Also integrate Miro with

ChatGPT Claude Agent SDK Claude Code Claude Cowork Codex OpenCode Cursor VS Code OpenClaw Hermes CLI Google ADK LangChain Vercel AI SDK Mastra AI LlamaIndex CrewAI

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

The Miro MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Miro account. It provides structured and secure access to your whiteboards, so your agent can create new boards, manage board content, organize workflows, and collaborate visually—all on your behalf.

Automated board creation and setup: Instantly instruct your agent to create new Miro boards with specific names and descriptions for projects, brainstorming, or workshops.
Visual content management: Ask your agent to add, retrieve, or delete items such as shapes, sticky notes, app cards, or document items from any board, keeping your workspace tidy and up to date.
Efficient team and member management: Have your agent fetch and list all members of a board so you can easily track collaborators and manage access.
Seamless board organization and retrieval: Let your agent search and retrieve boards by team, owner, or keyword to keep your workspace organized and easy to navigate.
Connector and tag insights: Direct your agent to get details on connectors and tags used within boards, helping you map relationships and categorize content visually.

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:

Composio API Key and OpenAI API Key
Primary know-how of OpenAI Agents SDK
A live Miro project
Some knowledge of Python or Typescript

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

Log in to the Composio dashboard.
Go to Settings and copy your API key.

Install dependencies

npm install @composio/openai-agents @openai/agents dotenv

Install the Composio SDK and the OpenAI Agents SDK.

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.

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 Miro.

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.

Create a Tool Router session

// Create Tool Router session for Miro
const session = await composio.create(userId as string, {
  toolkits: ['miro'],
});
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 miro.
The router checks the user's Miro connection and prepares the MCP endpoint.
The returned session.mcp.url is the MCP URL that your agent will use to access Miro.
This approach keeps things lightweight and lets the agent request Miro tools only when needed during the conversation.

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 Miro. Help users perform Miro 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 Miro 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 Miro operations without asking for permission each time, making interactions smoother.

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 Miro.
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 Miro 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: ['miro'],
  });
  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 Miro. Help users perform Miro 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 Miro MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Miro.

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

Attach Tag To Item

Tool to attach an existing tag to a specific item on a Miro board.

Create App Card Item

Tool to add an app card item to a board.

Create Board

Tool to create a new board.

Create Card Item

Tool to create a card item on a Miro board.

Create Connector

Tool to create a connector (edge/arrow) that links two existing board items.

Create Document Item

Tool to create a document item on a Miro board by providing a URL to the document.

Create Document Item Using File From Device

Tool to create a document item on a Miro board using a URL to the document.

Create Embed Item

Tool to create an embed item on a Miro board by providing a URL to embed content (YouTube videos, websites, etc.

Create Frame Item

Tool to add a frame item to a Miro board.

Create Group

Tool to create a group on a Miro board by grouping multiple items together.

Create Image Item Using Local File

Tool to create an image item on a Miro board by uploading a local image file.

Create Items in Bulk

Tool to create multiple items on a Miro board in a single request.

Create Mind Map Node (Experimental)

Tool to create a mind map node on a Miro board.

Create Shape Item

Tool to create a shape item on a Miro board.

Create Sticky Note Item

Tool to create a sticky note item on a Miro board.

Create Tag

Tool to create a new tag on a Miro board.

Create Text Item

Tool to create a text item on a Miro board.

Delete App Card Item

Tool to delete an app card item from a board.

Delete Card Item

Tool to delete a card item from a board.

Delete Connector

Tool to delete a specific connector from a board.

Delete Document Item

Tool to delete a document item from a board.

Delete Embed Item

Tool to delete an embed item from a board.

Delete Frame Item

Tool to delete a frame item from a Miro board.

Delete Group

Tool to delete a group from a board.

Delete Image Item

Tool to delete an image item from a board.

Delete Item

Tool to delete a specific item from a board.

Delete Mind Map Node (Experimental)

Tool to delete a mind map node from a board.

Delete Shape Item

Tool to delete a shape item from a board.

Delete Sticky Note Item

Tool to delete a sticky note item from a board.

Delete Tag

Tool to delete a specific tag from a board.

Delete Text Item

Tool to delete a text item from a board.

Get All Groups

Tool to retrieve all groups on a Miro board with cursor-based pagination.

Get App Card Item 2

Tool to retrieve a specific app card item by its ID from a Miro board.

Get Board Items

Tool to list items on a Miro board (shapes, stickies, cards, etc.

Get Board Members

Tool to retrieve a list of members for a board.

Get Boards V2

Tool to retrieve accessible boards with optional filters.

Get Card Item

Tool to retrieve a specific card item from a Miro board.

Get Connector

Tool to retrieve a specific connector by its ID.

Get Connectors

Tool to retrieve a list of connectors on a board.

Get Document Item

Tool to retrieve a specific document item from a Miro board by its ID.

Get Embed Item

Tool to retrieve a specific embed item from a board by its ID.

Get Frame Item

Tool to retrieve a specific frame item from a Miro board.

Get Group By ID

Tool to retrieve a specific group by its ID.

Get Image Item

Tool to retrieve a specific image item from a board.

Get Item Tags

Tool to retrieve tags attached to a specific item on a Miro board.

Get Mind Map Node

Tool to retrieve a specific mind map node from a board.

Get Mind Map Nodes (Experimental)

Tool to retrieve mind map nodes from a Miro board.

Get oEmbed Data

Tool to retrieve oEmbed data for a Miro board.

Get Shape Item

Tool to retrieve a specific shape item from a Miro board by its ID.

Get Specific Board

Tool to retrieve detailed information about a specific board by its ID.

Get Specific Board Member

Tool to retrieve details of a specific board member.

Get Specific Item

Tool to retrieve a specific item from a Miro board by its ID.

Get Sticky Note Item

Tool to retrieve a specific sticky note item from a board by its ID.

Get Tag

Tool to retrieve details of a specific tag on a board.

Get Text Item

Tool to retrieve a specific text item from a Miro board by its ID.

List Board Tags

Tool to list all tags on a Miro board.

Get Organization Context

Retrieves the organization associated with the current access token.

Share Board

Tool to share a board by inviting users via email.

Update App Card Item 2

Tool to update an app card item on a Miro board.

Update Board

Tool to update properties of a specific board.

Update Board Member

Tool to update the role of a specific board member.

Update Card Item

Tool to update a card item on a Miro board.

Update Connector

Tool to update an existing connector on a Miro board.

Update Document Item

Tool to update a document item on a Miro board.

Update Embed Item

Tool to update an embed item on a board.

Update Frame Item

Tool to update a frame item on a Miro board.

Update Group

Tool to update a group on a Miro board with new items.

Update Image Item

Tool to update an existing image item on a board.

Update Item Position or Parent

Tool to update an item's position or parent frame on a Miro board.

Update Shape Item

Tool to update an existing shape item on a Miro board.

Update Sticky Note Item

Tool to update a sticky note item on a Miro board.

Update Tag

Tool to update a tag on a board.

Update Text Item

Tool to update a text item on a Miro board.

FRAMEWORKS

How to build Miro MCP Agent with another framework

ChatGPT

Use Miro MCP with ChatGPT

Claude Agent SDK

Use Miro MCP with Claude Agent SDK

Claude Code

Use Miro MCP with Claude Code

Claude Cowork

Use Miro MCP with Claude Cowork

Codex

Use Miro MCP with Codex

Cursor

Use Miro MCP with Cursor

OpenClaw

Use Miro MCP with OpenClaw

Hermes

Use Miro MCP with Hermes

CLI

Use Miro MCP with CLI

Google ADK

Use Miro MCP with Google ADK

LangChain

Use Miro MCP with LangChain

Vercel AI SDK

Use Miro MCP with Vercel AI SDK

Mastra AI

Use Miro MCP with Mastra AI

LlamaIndex

Use Miro MCP with LlamaIndex

CrewAI

Use Miro MCP with CrewAI

OpenCode

Use Miro MCP with OpenCode

VS Code

Use Miro MCP with VS Code

MORE TOOLKITS

Explore Other Toolkits

Toolkit marketplace

Figma

Oauth2Api Key

Figma is a collaborative interface design tool for teams and individuals. It streamlines design workflows with real-time collaboration and easy sharing.

Abyssale

Api Key

Abyssale is a creative automation platform for generating images, videos, GIFs, PDFs, and HTML5 content programmatically. It streamlines and scales visual content production for marketing, design, and operations teams.

Alttext ai

Api Key

AltText.ai is a service that generates alt text for images automatically. It helps boost accessibility and SEO for your visual content.

Bannerbear

Api Key

Bannerbear is an API-driven platform for generating images and videos automatically at scale. It helps businesses create custom graphics, social visuals, and marketing assets using powerful templates.

FAQ

Frequently asked questions

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

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

Start with Miro.It takes 30 seconds.

Managed auth, hosted MCP servers, and every Miro 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 Miro MCP with OpenAI Agents SDK

Connect Miro without auth hassles

Introduction

Also integrate Miro with

TL;DR

What is OpenAI Agents SDK?

What is the Miro 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 dependencies

Set up the Composio instance

Create a Tool Router session

Configure the agent

Start chat loop and handle conversation

Complete Code

Conclusion

Supported Tools

How to build Miro MCP Agent with another framework

ChatGPT

Claude Agent SDK

Claude Code

Claude Cowork

Codex

Cursor

OpenClaw

Hermes

CLI

Google ADK

LangChain

Vercel AI SDK

Mastra AI

LlamaIndex

CrewAI

OpenCode

VS Code

Explore Other Toolkits

Figma

Abyssale

Alttext ai

Bannerbear

Frequently asked questions

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

Can I use Tool Router MCP with OpenAI Agents SDK?+

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

How safe is my data with Composio Tool Router?+

Start with Miro.It takes 30 seconds.

Teams ship real agents on Composio