MCPDocumentationResourcesMarketplaceCommunity
Documentation
Build your app

Introduction

Learn how to get started with Miro's MCP Server and related resources.

👍

MCP Community Challenge: 🏆 1000$ prize for each of the top 3 best demos of Miro's MCP Server in action. Details here.

🚀 Miro MCP Server (Beta)

Welcome to the official Miro Model Context Protocol (MCP) Server. This server bridges your AI assistants (like Cursor, Claude, and GitHub Copilot) directly with your Miro boards, enabling them to read context, generate code based on items on a Miro board, and visualize complex code & logic through diagrams.

⚠️ Beta Notice: This is a beta release. Features and UX are subject to change.
🔐 Enterprise Users: Your Admin must enable the MCP Server for your organization before you can connect. See Admin Guide.

📚 Core Resources

ResourceDescription
Official DocumentationComprehensive guides and API reference.
GitHub RepositorySource code, Claude Skills, issue tracking, and examples.
Tools & PromptsFull list of available capabilities and prompt commands.
Connection GuidesStep-by-step setup for various MCP clients.

📺 Tutorials & Guides

Visual and written guides to help you build faster.

⚡ Quick Start: Configuration

To connect most MCP clients, add the Miro MCP URL to your configuration file.

Server URL:
https://mcp.miro.com/

Generic Configuration (JSON)

Add this snippet to your mcp.json or tool settings:

{
  "mcpServers": {
    "miro-mcp": {
      "url": "https://mcp.miro.com/",
      "disabled": false,
      "autoApprove": []
    }
  }
}

Client-Specific Setup

For detailed instructions, visit the AI Coding Tools Guide.

  • Cursor: Settings > Features > MCP Servers > Add new (Type: HTTP).
  • Claude Code: Run claude mcp add --transport http miro https://mcp.miro.com.
  • VSCode + GitHub Copilot: Edit mcp.json via Command Palette (MCP: Open User Configuration).
  • Windsurf: Cascade > Manage MCPs > Configure.
  • Lovable: Project Settings > Integrations > Miro.
  • Replit: Install via the "Add Miro MCP" button in the Replit interface.
  • Kiro CLI: Add to .kiro/settings/mcp.json.

🛠 Features: Tools & Prompts

Miro’s MCP server exposes powerful tools to your AI agent. See the full list here.

🛠️ Key Tools

Tool NameDescriptionUses Miro AI Credits
board_list_itemsList items on a board with cursor-based pagination, supporting filters by item type and parent container.No
context_exploreDiscover high-level items on a board (frames, documents, prototypes, tables, diagrams) with their URLs and titles.No
context_getGet text context from a specific board item (documents return HTML, prototype screens return UI markup, frames return AI summaries).Yes
diagram_createCreate a diagram on a Miro board from DSL text (supports flowchart, UML class, UML sequence, and ERD).No
doc_updateEdit content in an existing doc format item using find-and-replace (supports single or all occurrences).No
image_get_urlGet the download URL for an image item from a Miro board.No
image_get_dataRetrieve the actual binary image data (base64-encoded) for an image item from a Miro board.No
table_createCreate a table on a Miro board with specified columns (supports text and select column types).No
table_list_rowsGet rows from a Miro table with column metadata, supporting filtering by column value and cursor-based pagination.No
table_sync_rowsAdd new rows or update existing rows in a table using key-based upsert matching.No

🤖 Key Prompts

Prompt NameUsageUse Case
code_create_from_board"Look at this wireframe and..."Analyzes board content (PRDs, wireframes) to generate code.
code_explain_on_board"Explain this code logic..."Visualizes complex code logic by creating diagrams on your board

🛡 Admin & Enterprise Guide

If you are on an Enterprise Plan, the MCP Server is disabled by default for security.

  • Admin Guide: How to Enable Miro MCP Server
  • Security Specs:
    • Auth: OAuth 2.1 (Dynamic Client Registration).
    • Permissions: Respects all existing board permissions and access controls.
    • Compliance: Data is processed securely following Miro's enterprise standards.

🤝 Support

Updated 6 days ago