README.md
Control Miro whiteboards with AI assistants
Miro MCP Server
Run your Miro workshops, retros, and planning sessions from the command line. Read boards, create stickies, organize frames, and generate diagrams through Claude, Cursor, or any MCP client.
Community project — Not officially affiliated with Miro. See official options below.
88 tools | Single binary | All platforms | All major AI tools
Documentation
| Document | Description |
|---|---|
| QUICKSTART.md | Get running in 2 minutes |
| SETUP.md | Full setup for all AI tools |
| CONFIG.md | Configuration reference |
| PERFORMANCE.md | Optimization guide |
| CHANGELOG.md | Version history |
| ERRORS.md | Error handling & troubleshooting |
Quick Start
1. Install
Homebrew (macOS/Linux):
brew tap olgasafonova/tap && brew install miro-mcp-server
One-liner (macOS/Linux):
curl -fsSL https://raw.githubusercontent.com/olgasafonova/miro-mcp-server/main/install.sh | sh
Docker:
docker pull ghcr.io/olgasafonova/miro-mcp-server:latest
Manual download: See SETUP.md for all platforms
2. Get a Miro Token
- Go to miro.com/app/settings/user-profile/apps
- Create an app with
boards:readandboards:writepermissions - Install to your team and copy the token
3. Configure Your AI Tool
Claude Code:
claude mcp add miro -e MIRO_ACCESS_TOKEN=your-token -- miro-mcp-server
Claude Desktop / Cursor / VS Code: See SETUP.md
Cursor Marketplace:
/add-plugin miro
Not working? Tell us what made it hard — even one sentence helps.
What You Can Do
| Category | Examples |
|---|---|
| Boards | Create, copy, delete, update, share, list members |
| Items | Sticky notes, shapes, text, cards, app cards, images, documents, frames, docs |
| Diagrams | Generate flowcharts and sequence diagrams from Mermaid |
| Docs | Create and manage Markdown documents on boards |
| Upload | Upload and replace local image and document files on boards |
| Mindmaps | Create mindmap nodes with parent-child relationships |
| Bulk Ops | Create multiple items at once, sticky grids |
| Tags | Create, attach, update, and organize with tags |
| Groups | Group, list, and manage item groups |
| Connectors | Connect items with styled arrows |
| Export | Board thumbnails, PDF/SVG export (Enterprise) |
Voice Examples
- "Add a yellow sticky saying 'Review PRs'"
- "Create a flowchart: Start → Decision → End"
- "What boards do I have?"
- "Share the Design board with jane@example.com"
- "Create a mindmap with 'Project Ideas' as root"
All 88 Tools
Board Management (9)
| Tool | Description |
|---|---|
miro_list_boards |
List accessible boards |
miro_find_board |
Find board by name |
miro_get_board |
Get board details |
miro_get_board_summary |
Get board stats and item counts |
miro_get_board_content |
Get all board content for AI analysis |
miro_create_board |
Create a new board |
miro_copy_board |
Copy an existing board |
miro_update_board |
Update board name/description |
miro_delete_board |
Delete a board |
Board Members (5)
| Tool | Description |
|---|---|
miro_list_board_members |
List users with access |
miro_get_board_member |
Get member details |
miro_share_board |
Share board via email |
miro_update_board_member |
Update member role |
miro_remove_board_member |
Remove member from board |
Create Items (18)
| Tool | Description |
|---|---|
miro_create_sticky |
Create a sticky note |
miro_create_sticky_grid |
Create stickies in a grid layout |
miro_create_shape |
Create a shape (rectangle, circle, etc.) |
miro_create_flowchart_shape |
Create flowchart shape (experimental API) |
miro_create_text |
Create text element |
| `miro_create_fram |
Tools (19)
miro_list_boardsList accessible boardsmiro_find_boardFind board by namemiro_get_boardGet board detailsmiro_get_board_summaryGet board stats and item countsmiro_get_board_contentGet all board content for AI analysismiro_create_boardCreate a new boardmiro_copy_boardCopy an existing boardmiro_update_boardUpdate board name/descriptionmiro_delete_boardDelete a boardmiro_list_board_membersList users with accessmiro_get_board_memberGet member detailsmiro_share_boardShare board via emailmiro_update_board_memberUpdate member rolemiro_remove_board_memberRemove member from boardmiro_create_stickyCreate a sticky notemiro_create_sticky_gridCreate stickies in a grid layoutmiro_create_shapeCreate a shape (rectangle, circle, etc.)miro_create_flowchart_shapeCreate flowchart shape (experimental API)miro_create_textCreate text elementEnvironment Variables
MIRO_ACCESS_TOKENrequiredMiro API access token with boards:read and boards:write permissionsConfiguration
claude_desktop_config.json
{"mcpServers": {"miro": {"command": "miro-mcp-server", "env": {"MIRO_ACCESS_TOKEN": "your-token"}}}}Try it
→Add a yellow sticky saying 'Review PRs' to my current board.
→Create a flowchart: Start -> Decision -> End.
→What boards do I have in my Miro account?
→Share the 'Design' board with jane@example.com.
→Create a mindmap with 'Project Ideas' as the root node.