🚀 Miro MCP 服务器

这是一个实验性的模型控制协议 (MCP) 服务器，用于与 Miro API 和单块板交互。它能将 Miro API 端点作为工具公开，供 AI 代理使用，让 AI 代理对 Miro 资料板进行编程操作。

🚀 快速开始

本项目提供了两种安装方式，你可按需选择：

无需 Docker 的安装

1. 克隆仓库：

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

2. 安装依赖项：

   npm install
   

3. 在根目录中创建一个 .env 文件，包含以下变量：

   MIRO_API_TOKEN=你的_miro_api_token
   MIRO_BOARD_ID=你的_miro_board_id
   
   # 可选，端口
   PORT=3000
   

4. 启动服务器： 你可以选择以下两种方式启动服务器：

   npm run dev
   

   或者

   npm run build
   npm start
   

5. 服务器将在 http://localhost:8899/sse 上运行，此时 AI 代理就可以通过 MCP 协议使用暴露的 Miro API 工具。

使用 Docker

# 具体命令取决于你的 Docker 版本
docker compose up -d
docker-compose up -d

# 服务器应该在默认端口或你选择的端口上运行

✨ 主要特性

• 广泛支持：支持所有主要的 Miro 资料板项目类型，包括备注、形状、文本、图像、卡片、应用卡片、文档、嵌入、连接器。
• 自动生成：自动从 Miro OpenAPI 规范生成工具定义，方便 AI 代理使用。

📦 安装指南

环境准备

• Node.js
• 带有 API 访问权限的 Miro 账户
• Miro API 令牌
• Miro 资料板 ID

安装步骤

如快速开始部分所述，提供了无需 Docker 和使用 Docker 两种安装方式。

💻 使用示例

启动服务器

# 开发环境启动
npm run dev

# 生产环境启动
npm run build
npm start

与服务器交互

服务器运行后，AI 代理可以通过访问 http://localhost:8899/sse 并使用 MCP 协议与暴露的 Miro API 工具进行交互。

📚 详细文档

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：更新特定卡片。

连接器操作

• get_connection：获取连接信息。
• add_connection：添加一个连接。
• remove_connection：删除一个连接。

文档操作

• get_document：获取文档内容。
• update_document：更新文档内容。

嵌入操作

• get_embed：获取嵌入内容。
• update_embed：更新嵌入内容。

🔧 技术细节

该项目提供了一个 FastMCP 服务器，其核心是将 Miro API 端点作为工具公开给 AI 代理。通过自动从 Miro OpenAPI 规范生成工具定义，使得 AI 代理能够方便地对 Miro 资料板进行编程操作。服务器使用 Node.js 构建，结合相关依赖实现与 Miro API 的交互和工具的暴露。

📄 注意事项

⚠️ 重要提示

• 确保 API 令牌具有适当的权限以执行所需的操作。
• 端口变量 PORT 是可选的，默认值为 3000。

💡 使用建议

服务器运行后，可以通过访问 http://localhost:8899/sse 进行交互。