MCP Server Miro

🚀 Miro MCP Server

An experimental Model Control Protocol (MCP) server for interacting with the Miro API and single-board computers.

🚀 Quick Start

This project offers a FastMCP server that exposes Miro API endpoints as tools for AI agents. It automatically generates tool definitions from the Miro OpenAPI specification, enabling AI agents to programmatically operate on Miro boards.

✨ Features

• Supports all major Miro board item types:
  • Sticky notes
  • Shapes
  • Text
  • Images
  • Cards
  • App cards
  • Documents
  • Embeds
  • Connectors

📦 Installation

Prerequisites

• Node.js
• A Miro account with API access
• A Miro API token
• A Miro board ID

Installation without Docker

1. Clone the repository:

   git clone https://github.com/yourusername/mcp-server-miro.git
   cd mcp-server-miro
   

2. Install dependencies:

   npm install
   

3. Create a .env file in the root directory with the following variables:

   MIRO_API_TOKEN=your_miro_api_token
   MIRO_BOARD_ID=your_miro_board_id
   
   # Optional, port
   PORT=3000
   

Usage

1. Start the server:

   npm run dev
   

   Or

   npm run build
   npm start
   

2. The server will run at http://localhost:8899/sse.

3. AI agents can now use the exposed Miro API tools via the MCP protocol.

Using Docker

# Specific commands depend on your Docker version
docker compose up -d
docker-compose up -d

# The server should run on the default port or the port you choose.

📚 Documentation

API Tools

The server exposes the following Miro API endpoints as tools:

Board Operations:

• get_specific_board: Get information about the current board.
• update_board: Update the current board.

General Item Operations:

• get_items: Get a list of items on the board (supports filtering and pagination).
• update_item_position_or_parent: Update the current position or parent of a specific item.
• delete_item: Delete a specific item (covers various types such as sticky notes, text, shapes, etc.).

Sticky Note Operations:

• create_sticky_note_item: Add a sticky note.
• get_sticky_note_item: Get a specific sticky note.
• update_sticky_note_item: Update a specific sticky note.

Text Operations:

• create_text_item: Add a text.
• get_text_item: Get a specific text.
• update_text_item: Update a specific text.

Shape Operations:

• create_shape_item: Add a shape item.
• get_shape_item: Get a specific shape.
• update_shape_item: Update a specific shape.

Card Operations:

• create_card_item: Create a card.
• get_card_item: Get a specific card.
• update_card_item: Update a specific card.

Connector Operations:

• get_connection: Get connection information.
• add_connection: Add a connection.
• remove_connection: Delete a connection.

Document Operations:

• get_document: Get document content.
• update_document: Update document content.

Embed Operations:

• get_embed: Get embed content.
• update_embed: Update embed content.

📄 License

No license information provided in the original document, so this section is skipped.

⚠️ Important Note

• Ensure that the API token has appropriate permissions to perform the required operations.
• The port variable PORT is optional, and the default value is 3000.
• After the server is running, you can interact with it by accessing http://localhost:8899/sse.