Miro MCP 服务器

一个实验性的模型控制协议 (MCP) 服务器，用于与 Miro API 和单板进行交互。

概述

本项目提供了一个 FastMCP 服务器，它将 Miro API 端点公开为可供 AI 代理使用的工具。它自动从 Miro OpenAPI 规范生成工具定义，允许 AI 代理以编程方式操作 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
   
   # 可选，端口
   PORT=3000
   

用法

1. 启动服务器：

   npm run dev
   

   或

   npm run build
   npm start
   

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

3. AI 代理现在可以通过 MCP 协议使用公开的 Miro API 工具

使用 Docker

# 确切的命令取决于您的 Docker 版本
docker compose up -d
docker-compose up -d

# 服务器应该在默认端口或您选择的端口上启动

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