一个实验性模型控制协议(MCP)服务器,用于与米罗API和一板互动.

□ 概览

这个项目提供了一个FastMCP服务器,将米罗API端点暴露为AI代理可以使用的工具. 它从米罗OpenAPI规格中自动生成工具定义,允许AI代理在程序上操纵米罗板.

□ 特性

• 支持所有主要米罗板项目类型:
• 粘性笔记
• 形状
• 语句
• 图像
• 纸牌
• 应用卡
• 文档
• 内嵌物
• 连接器

□ 先决条件

• 节点.js
• 一个有API接入的米罗账户
• 一个米罗API标志
• 一个米罗板ID

□ 安装不挂载

1. 清除储存库:

2. 安装依赖性:

3. 在根目录中创建一个带有下列变量的 .env 文件:

使用量

1. 启动服务器:

或者说

2. 服务器起于http://localhost:8899/sse

3. AI代理现在可以通过MCP协议使用已曝光的米罗API工具

□与多克一起使用

□ API 工具

服务器将以下米罗 API 端点曝光为工具 :

** 董事会业务:**

• [[T2]: 获取当前棋盘的信息.

Miro MCP Server

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

Overview

This project provides a FastMCP server that exposes Miro API endpoints as tools that can be used by AI agents. It automatically generates tool definitions from the Miro OpenAPI specification, allowing AI agents to manipulate Miro boards programmatically.

Features

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

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 start at http://localhost:8899/sse

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

Using with Docker

# The exact command depends on your Docker version
docker compose up -d
docker-compose up -d

# Server should be up in default port or the one you chose

API Tools

The server exposes the following Miro API endpoints as tools:

Board Operations:

• get_specific_board: Retrieves information about the current board.
• update_board: Updates the current board.

Generic Item Operations:

• get_items: Retrieves a list of items on the board (supports filtering and pagination).
• update_item_position_or_parent: Updates the position or parent of a specific item.
• delete_item: Deletes a specific item (covers various types like sticky notes, text, shapes, etc.).

Sticky Note Operations:

• create_sticky_note_item: Adds a sticky note.
• get_sticky_note_item: Retrieves a specific sticky note.
• update_sticky_note_item: Updates a specific sticky note.

Text Operations:

• create_text_item: Adds a text item.
• get_text_item: Retrieves a specific text item.
• update_text_item: Updates a specific text item.

Shape Operations:

• create_shape_item: Adds a shape item.
• get_shape_item: Retrieves a specific shape item.
• update_shape_item: Updates a specific shape item.

Card Operations:

• create_card_item: Adds a card item.
• get_card_item: Retrieves a specific card item.
• update_card_item: Updates a specific card item.

Connector Operations:

• create_connector: Adds a connector between items.
• get_connectors: Retrieves a list of connectors.
• get_connector: Retrieves a specific connector.
• update_connector: Updates a specific connector.