Miro API控制服务器

一个实验性的Miro API控制协议服务器,用于通过AI代理程序化操作Miro白板内容。

  • by LuotoCompany
  • TypeScript
  • 本地部署
  • 16 星标
  • 更新于
在 GitHub 查看 LuotoCompany/mcp-server-miro

使用说明

Miro MCP服务器

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

概述

该项目提供了一个FastMCP服务器,该服务器将Miro API端点公开为人工智能代理可以使用的工具。它根据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
    
    # Optional, port
    PORT=3000
    

用法

  1. 启动服务器:

    npm run dev
    

    或

    npm run build
    npm start
    
  2. 服务器将在以下时间启动 http://localhost:8899/sse

  3. 人工智能代理现在可以通过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)

许可证

麻省理工学院