项目简介
MCP Miro 服务器是一个实现了 Model Context Protocol (MCP) 的应用后端,它作为AI助手(如Claude Desktop)与Miro白板平台之间的桥梁。通过标准化接口,AI助手可以无需直接集成Miro API,而是通过与此MCP服务器通信来访问和操作Miro画板。
主要功能点
- 画板管理: 允许AI助手列出、创建、更新、删除和复制Miro画板。
- 画板内容操作: 支持在画板上创建、获取、更新和删除多种类型的元素,包括:
- 便签 (Sticky notes)
- 卡片 (Cards)
- 文本 (Text)
- 形状 (Shapes)
- 图片 (Images),支持通过URL或文件数据创建和更新
- 内嵌内容 (Embeds)
- 连接线 (Connectors)
- 框架 (Frames)
- 文档 (Documents)
- 思维导图节点 (Mindmap nodes)
- 批量操作: 支持一次性创建多个指定类型的画板元素。
- 标签管理: 允许创建、获取、更新、删除、附加和解除标签。
- 成员管理: 支持获取画板成员列表以及获取特定成员信息、移除成员或更新成员角色。
- 画板共享: 允许设置画板的共享策略。
- 分组管理: 支持创建、获取、更新、删除分组以及将元素解除分组。
- 企业级功能 (需企业版Miro账户): 包括获取组织信息、组织成员、项目成员,添加/移除项目成员,获取审计日志、数据分类、创建/获取画板导出任务状态和结果,以及获取法律保留信息和内容。
安装步骤
- 确保您的系统已安装 Node.js v16 或更新版本。
- 在 Miro 开发者平台 (https://developers.miro.com/docs) 创建或使用一个现有应用,并生成一个包含所需权限的OAuth访问令牌。所需的权限在仓库的 'README.md' 中有详细列表。
- 克隆此GitHub仓库到本地。
- 打开终端,进入仓库目录,运行以下命令安装项目依赖:
npm install - 复制 '.env.template' 文件并重命名为 '.env':
cp .env.template .env - 编辑新创建的 '.env' 文件,将您生成的 Miro 访问令牌添加到 'MIRO_ACCESS_TOKEN' 变量中:
MIRO_ACCESS_TOKEN=your_miro_access_token_here - 构建服务器代码:
npm run build - (可选,用于本地测试)您可以通过以下命令直接运行服务器:
但通常情况下,这个服务器会被MCP客户端(如AI助手应用)自动启动和管理。node build/index.js
MCP客户端配置(例如 Claude Desktop)
要让您的AI助手使用此Miro MCP服务器,您需要在AI助手的配置文件中添加服务器配置。以 Claude Desktop 为例(具体文件路径和格式请参考您使用的MCP客户端文档):
在您的Claude Desktop配置文件 ('claude_desktop_config.json') 中,找到 'mcpServers' 部分,并添加一个条目,例如命名为 'miro':
{ "mcpServers":{ "miro":{ // 指定启动MCP服务器的命令 "command":"npx", // 指定命令的参数。@k-jarzyna/mcp-miro 是发布到npm的项目包名, // npx可以直接执行该包中的可执行文件 (通常是构建后的index.js)。 "args":[ "-y", // npx参数,表示自动确认安装 "@k-jarzyna/mcp-miro" // 要执行的npm包名 ], // 将您的Miro访问令牌作为环境变量传递给服务器进程 "env":{ "MIRO_ACCESS_TOKEN":"your_miro_access_token" // 您的Miro访问令牌 } } } }
完成配置后,重启您的MCP客户端应用。它应该会自动发现并连接到此Miro MCP服务器。
基本使用方法
一旦MCP客户端成功连接到Miro MCP服务器,您的AI助手就可以通过调用服务器注册的工具来与Miro进行交互。您可以通过与AI助手对话,描述您想在Miro画板上执行的操作(例如,“列出我的Miro画板”,“在画板[板ID]上创建一个便签,内容是'待办事项',放在坐标(100, 200)'”),AI助手会识别您的意图并调用相应的Miro MCP工具来完成任务。您无需手动运行服务器,MCP客户端会按需启动它。
信息
分类
AI与计算