Miro MCP Server

Miro MCP Server

一个用于与 Miro API 和单个白板交互的实验性 Model Control Protocol（MCP）服务。

概述

此项目提供了一个 FastMCP 服务，将 Miro API 端点作为工具开放，供 AI Agent 使用。它会根据 Miro OpenAPI 规范自动生成工具定义，使 AI Agent 能以编程方式操作 Miro 白板。

功能

• 支持所有主要的 Miro 白板项目类型：
  • 便笺
  • 形状
  • 文本
  • 图片
  • 卡片
  • 应用卡片
  • 文档
  • 嵌入项
  • 连接器

前提条件

• Node.js
• 拥有 API 访问权限的 Miro 账号
• Miro API 令牌
• Miro 白板 ID

不使用 Docker 安装

1. 克隆仓库：

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

2. 安装依赖：

   npm install
   

3. 在根目录中创建 .env 文件，并添加以下变量：

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

使用方法

1. 启动服务：

   npm run dev
   

   或

   npm run build
   npm start
   

2. 服务将在 http://localhost:8899/sse 启动

3. AI Agent 现在可以通过 MCP 协议使用已开放的 Miro API 工具

使用 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 工具

此服务将以下 Miro API 端点作为工具开放：

白板操作：

• get_specific_board：获取当前白板的信息。
• update_board：更新当前白板。

通用项目操作：

• get_items：获取白板上的项目列表（支持筛选和分页）。
• update_item_position_or_parent：更新特定项目的位置或父级。
• delete_item：删除特定项目（涵盖便笺、文本、形状等多种类型）。

便笺操作：

• create_sticky_note_item：添加便笺。
• get_sticky_note_item：获取特定便笺。
• update_sticky_note_item：更新特定便笺。

文本操作：

• create_text_item：添加文本项目。
• get_text_item：获取特定文本项目。
• update_text_item：更新特定文本项目。

形状操作：

• create_shape_item：添加形状项目。
• get_shape_item：获取特定形状项目。
• update_shape_item：更新特定形状项目。

卡片操作：

• create_card_item：添加卡片项目。
• get_card_item：获取特定卡片项目。
• update_card_item：更新特定卡片项目。

连接器操作：

• create_connector：在项目之间添加连接器。
• get_connectors：获取连接器列表。
• get_connector：获取特定连接器。
• update_connector：更新特定连接器。
• delete_connector：删除特定连接器。

文档操作：

• create_document_item_using_url：通过 URL 添加文档项目。
• update_document_item_using_url：更新通过 URL 添加的文档项目。 （注：通过 get_items 获取特定文档）

嵌入项操作：

• create_embed_item：通过 URL 添加嵌入项。
• update_embed_item：更新嵌入项。 （注：通过 get_items 获取特定嵌入项）

图片操作：

• create_image_item_using_url：通过 URL 添加图片项目。
• update_image_item_using_url：更新通过 URL 添加的图片项目。 （注：通过 get_items 获取特定图片）

应用卡片操作：

• create_app_card_item：添加应用卡片项目。
• update_app_card_item：更新应用卡片项目。 （注：通过 get_items 获取特定应用卡片）

许可证

MIT