MCP Server Miro

🚀 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 進行交互。