How to integrate Miro MCP with OpenAI Agents SDK

Trusted by
AWS
Glean
Zoom
Airtable
GET STARTED FOR FREEGET A DEMO

30 min · no commitment · see it on your stack

Miro logo
OpenAI Agents SDK logo
divider

Introduction

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.

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

Supported Tools & Triggers

Tools
Attach Tag To ItemTool to attach an existing tag to a specific item on a Miro board.
Create App Card ItemTool to add an app card item to a board.
Create BoardTool to create a new board.
Create Card ItemTool to create a card item on a Miro board.
Create ConnectorTool to create a connector (edge/arrow) that links two existing board items.
Create Document ItemTool to create a document item on a Miro board by providing a URL to the document.
Create Document Item Using File From DeviceTool to create a document item on a Miro board using a URL to the document.
Create Embed ItemTool to create an embed item on a Miro board by providing a URL to embed content (YouTube videos, websites, etc.
Create Frame ItemTool to add a frame item to a Miro board.
Create GroupTool to create a group on a Miro board by grouping multiple items together.
Create Image Item Using Local FileTool to create an image item on a Miro board by uploading a local image file.
Create Items in BulkTool 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 ItemTool to create a shape item on a Miro board.
Create Sticky Note ItemTool to create a sticky note item on a Miro board.
Create TagTool to create a new tag on a Miro board.
Create Text ItemTool to create a text item on a Miro board.
Delete App Card ItemTool to delete an app card item from a board.
Delete Card ItemTool to delete a card item from a board.
Delete ConnectorTool to delete a specific connector from a board.
Delete Document ItemTool to delete a document item from a board.
Delete Embed ItemTool to delete an embed item from a board.
Delete Frame ItemTool to delete a frame item from a Miro board.
Delete GroupTool to delete a group from a board.
Delete Image ItemTool to delete an image item from a board.
Delete ItemTool 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 ItemTool to delete a shape item from a board.
Delete Sticky Note ItemTool to delete a sticky note item from a board.
Delete TagTool to delete a specific tag from a board.
Delete Text ItemTool to delete a text item from a board.
Get All GroupsTool to retrieve all groups on a Miro board with cursor-based pagination.
Get App Card Item 2Tool to retrieve a specific app card item by its ID from a Miro board.
Get Board ItemsTool to list items on a Miro board (shapes, stickies, cards, etc.
Get Board MembersTool to retrieve a list of members for a board.
Get Boards V2Tool to retrieve accessible boards with optional filters.
Get Card ItemTool to retrieve a specific card item from a Miro board.
Get ConnectorTool to retrieve a specific connector by its ID.
Get ConnectorsTool to retrieve a list of connectors on a board.
Get Document ItemTool to retrieve a specific document item from a Miro board by its ID.
Get Embed ItemTool to retrieve a specific embed item from a board by its ID.
Get Frame ItemTool to retrieve a specific frame item from a Miro board.
Get Group By IDTool to retrieve a specific group by its ID.
Get Image ItemTool to retrieve a specific image item from a board.
Get Item TagsTool to retrieve tags attached to a specific item on a Miro board.
Get Mind Map NodeTool 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 DataTool to retrieve oEmbed data for a Miro board.
Get Shape ItemTool to retrieve a specific shape item from a Miro board by its ID.
Get Specific BoardTool to retrieve detailed information about a specific board by its ID.
Get Specific Board MemberTool to retrieve details of a specific board member.
Get Specific ItemTool to retrieve a specific item from a Miro board by its ID.
Get Sticky Note ItemTool to retrieve a specific sticky note item from a board by its ID.
Get TagTool to retrieve details of a specific tag on a board.
Get Text ItemTool to retrieve a specific text item from a Miro board by its ID.
List Board TagsTool to list all tags on a Miro board.
Get Organization ContextRetrieves the organization associated with the current access token.
Share BoardTool to share a board by inviting users via email.
Update App Card Item 2Tool to update an app card item on a Miro board.
Update BoardTool to update properties of a specific board.
Update Board MemberTool to update the role of a specific board member.
Update Card ItemTool to update a card item on a Miro board.
Update ConnectorTool to update an existing connector on a Miro board.
Update Document ItemTool to update a document item on a Miro board.
Update Embed ItemTool to update an embed item on a board.
Update Frame ItemTool to update a frame item on a Miro board.
Update GroupTool to update a group on a Miro board with new items.
Update Image ItemTool to update an existing image item on a board.
Update Item Position or ParentTool to update an item's position or parent frame on a Miro board.
Update Shape ItemTool to update an existing shape item on a Miro board.
Update Sticky Note ItemTool to update a sticky note item on a Miro board.
Update TagTool to update a tag on a board.
Update Text ItemTool to update a text item on a Miro board.

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

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

Install dependencies

pip install composio_openai_agents openai-agents python-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 asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession
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

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())
What's happening:
  • load_dotenv() loads your .env file so OPENAI_API_KEY and COMPOSIO_API_KEY are available as environment variables.
  • Creating a Composio instance using the API Key and OpenAIAgentsProvider class.

Create a Tool Router session

# Create a Miro Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["miro"]
)

mcp_url = 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
agent = 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(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "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 dict includes the Composio API key for secure authentication with the MCP server.
  • require_approval: 'never' means the agent can execute Miro operations without asking for permission each time, making interactions smoother.

Start chat loop and handle conversation

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())
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 Runner.run().
  • The responses are printed to the console, and conversations are saved locally using SQLite.
  • 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 asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())

# Create Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["miro"]
)
mcp_url = session.mcp.url

# Configure agent with MCP tool
agent = 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(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "never",
            }
        )
    ],
)

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())

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.

How to build Miro MCP Agent with another framework

ChatGPT logo

ChatGPT

Use Miro MCP with ChatGPT

Antigravity logo

Antigravity

Use Miro MCP with Antigravity

Claude Agent SDK logo

Claude Agent SDK

Use Miro MCP with Claude Agent SDK

Claude Code logo

Claude Code

Use Miro MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use Miro MCP with Claude Cowork

Codex logo

Codex

Use Miro MCP with Codex

Cursor logo

Cursor

Use Miro MCP with Cursor

OpenClaw logo

OpenClaw

Use Miro MCP with OpenClaw

Hermes logo

Hermes

Use Miro MCP with Hermes

CLI logo

CLI

Use Miro MCP with CLI

Google ADK logo

Google ADK

Use Miro MCP with Google ADK

LangChain logo

LangChain

Use Miro MCP with LangChain

Vercel AI SDK logo

Vercel AI SDK

Use Miro MCP with Vercel AI SDK

Mastra AI logo

Mastra AI

Use Miro MCP with Mastra AI

LlamaIndex logo

LlamaIndex

Use Miro MCP with LlamaIndex

CrewAI logo

CrewAI

Use Miro MCP with CrewAI

OpenCode logo

OpenCode

Use Miro MCP with OpenCode

VS Code logo

VS Code

Use Miro MCP with VS Code

FAQ

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

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.

Can I use Tool Router MCP with OpenAI Agents SDK?

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.

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

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.

How safe is my data with Composio Tool Router?

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.

Used by agents from

Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai

Never worry about agent reliability

We handle tool reliability, observability, and security so you never have to second-guess an agent action.

Get started for freeGet a demo↗
Miro MCP Integration with OpenAI Agents SDK | Composio