How to integrate Miro MCP with Pydantic AI

This guide walks you through connecting Miro to Pydantic AI 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 Pydantic AI 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 freeGet a demo
Miro logoMiro
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

Introduction

This guide walks you through connecting Miro to Pydantic AI 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 Pydantic AI 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

ChatGPTOpenAI Agents SDKClaude Agent SDKClaude CodeClaude CoworkCodexOpenCodeCursorVS CodeOpenClawHermesCLIGoogle ADKLangChainVercel AI SDKMastra AILlamaIndexCrewAI

TL;DR

Here's what you'll learn:
  • How to set up your Composio API key and User ID
  • How to create a Composio Tool Router session for Miro
  • How to attach an MCP Server to a Pydantic AI agent
  • How to stream responses and maintain chat history
  • How to build a simple REPL-style chat interface to test your Miro workflows

What is Pydantic AI?

Pydantic AI is a Python framework for building AI agents with strong typing and validation. It leverages Pydantic's data validation capabilities to create robust, type-safe AI applications.

Key features include:

  • Type Safety: Built on Pydantic for automatic data validation
  • MCP Support: Native support for Model Context Protocol servers
  • Streaming: Built-in support for streaming responses
  • Async First: Designed for async/await patterns

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:

  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:
  • Python 3.9 or higher
  • A Composio account with an active API key
  • Basic familiarity with Python and async programming
2

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

bash
pip install composio pydantic-ai python-dotenv

Install the required libraries.

What's happening:

  • composio connects your agent to external SaaS tools like Miro
  • pydantic-ai lets you create structured AI agents with tool support
  • python-dotenv loads your environment variables securely from a .env file
4

Set up environment variables

bash
COMPOSIO_API_KEY=your_composio_api_key_here
USER_ID=your_user_id_here
OPENAI_API_KEY=your_openai_api_key

Create a .env file in your project root.

What's happening:

  • COMPOSIO_API_KEY authenticates your agent to Composio's API
  • USER_ID associates your session with your account for secure tool access
  • OPENAI_API_KEY to access OpenAI LLMs
5

Import dependencies

python
import asyncio
import os
from dotenv import load_dotenv
from composio import Composio
from pydantic_ai import Agent
from pydantic_ai.mcp import MCPServerStreamableHTTP

load_dotenv()
What's happening:
  • We load environment variables and import required modules
  • Composio manages connections to Miro
  • MCPServerStreamableHTTP connects to the Miro MCP server endpoint
  • Agent from Pydantic AI lets you define and run the AI assistant
6

Create a Tool Router Session

python
async def main():
    api_key = os.getenv("COMPOSIO_API_KEY")
    user_id = os.getenv("USER_ID")
    if not api_key or not user_id:
        raise RuntimeError("Set COMPOSIO_API_KEY and USER_ID in your environment")

    # Create a Composio Tool Router session for Miro
    composio = Composio(api_key=api_key)
    session = composio.create(
        user_id=user_id,
        toolkits=["miro"],
    )
    url = session.mcp.url
    if not url:
        raise ValueError("Composio session did not return an MCP URL")
What's happening:
  • We're creating a Tool Router session that gives your agent access to Miro tools
  • The create method takes the user ID and specifies which toolkits should be available
  • The returned session.mcp.url is the MCP server URL that your agent will use
7

Initialize the Pydantic AI Agent

python
# Attach the MCP server to a Pydantic AI Agent
miro_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY})
agent = Agent(
    "openai:gpt-5",
    toolsets=[miro_mcp],
    instructions=(
        "You are a Miro assistant. Use Miro tools to help users "
        "with their requests. Ask clarifying questions when needed."
    ),
)
What's happening:
  • The MCP client connects to the Miro endpoint
  • The agent uses GPT-5 to interpret user commands and perform Miro operations
  • The instructions field defines the agent's role and behavior
8

Build the chat interface

python
# Simple REPL with message history
history = []
print("Chat started! Type 'exit' or 'quit' to end.\n")
print("Try asking the agent to help you with Miro.\n")

while True:
    user_input = input("You: ").strip()
    if user_input.lower() in {"exit", "quit", "bye"}:
        print("\nGoodbye!")
        break
    if not user_input:
        continue

    print("\nAgent is thinking...\n", flush=True)

    async with agent.run_stream(user_input, message_history=history) as stream_result:
        collected_text = ""
        async for chunk in stream_result.stream_output():
            text_piece = None
            if isinstance(chunk, str):
                text_piece = chunk
            elif hasattr(chunk, "delta") and isinstance(chunk.delta, str):
                text_piece = chunk.delta
            elif hasattr(chunk, "text"):
                text_piece = chunk.text
            if text_piece:
                collected_text += text_piece
        result = stream_result

    print(f"Agent: {collected_text}\n")
    history = result.all_messages()
What's happening:
  • The agent reads input from the terminal and streams its response
  • Miro API calls happen automatically under the hood
  • The model keeps conversation history to maintain context across turns
9

Run the application

python
if __name__ == "__main__":
    asyncio.run(main())
What's happening:
  • The asyncio loop launches the agent and keeps it running until you exit

Complete Code

Here's the complete code to get you started with Miro and Pydantic AI:

python
import asyncio
import os
from dotenv import load_dotenv
from composio import Composio
from pydantic_ai import Agent
from pydantic_ai.mcp import MCPServerStreamableHTTP

load_dotenv()

async def main():
    api_key = os.getenv("COMPOSIO_API_KEY")
    user_id = os.getenv("USER_ID")
    if not api_key or not user_id:
        raise RuntimeError("Set COMPOSIO_API_KEY and USER_ID in your environment")

    # Create a Composio Tool Router session for Miro
    composio = Composio(api_key=api_key)
    session = composio.create(
        user_id=user_id,
        toolkits=["miro"],
    )
    url = session.mcp.url
    if not url:
        raise ValueError("Composio session did not return an MCP URL")

    # Attach the MCP server to a Pydantic AI Agent
    miro_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY})
    agent = Agent(
        "openai:gpt-5",
        toolsets=[miro_mcp],
        instructions=(
            "You are a Miro assistant. Use Miro tools to help users "
            "with their requests. Ask clarifying questions when needed."
        ),
    )

    # Simple REPL with message history
    history = []
    print("Chat started! Type 'exit' or 'quit' to end.\n")
    print("Try asking the agent to help you with Miro.\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "bye"}:
            print("\nGoodbye!")
            break
        if not user_input:
            continue

        print("\nAgent is thinking...\n", flush=True)

        async with agent.run_stream(user_input, message_history=history) as stream_result:
            collected_text = ""
            async for chunk in stream_result.stream_output():
                text_piece = None
                if isinstance(chunk, str):
                    text_piece = chunk
                elif hasattr(chunk, "delta") and isinstance(chunk.delta, str):
                    text_piece = chunk.delta
                elif hasattr(chunk, "text"):
                    text_piece = chunk.text
                if text_piece:
                    collected_text += text_piece
            result = stream_result

        print(f"Agent: {collected_text}\n")
        history = result.all_messages()

if __name__ == "__main__":
    asyncio.run(main())

Conclusion

You've built a Pydantic AI agent that can interact with Miro through Composio's Tool Router. With this setup, your agent can perform real Miro actions through natural language. You can extend this further by:
  • Adding other toolkits like Gmail, HubSpot, or Salesforce
  • Building a web-based chat interface around this agent
  • Using multiple MCP endpoints to enable cross-app workflows (for example, Gmail + Miro for workflow automation)
This architecture makes your AI agent "agent-native", able to securely use APIs in a unified, composable way without custom integrations.
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 logo

ChatGPT

Use Miro MCP with ChatGPT

OpenAI Agents SDK logo

OpenAI Agents SDK

Use Miro MCP with OpenAI Agents SDK

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

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