Miro MCP Server

这是一个实验性的模型控制协议（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

</中文翻译>