MiroEx——法学硕士Miro读卡器
MCP服务器,将Miro板转换为结构化、机器可读的文本。通过Miro REST API获取板元素,在空间上对其进行聚类,并为Claude提供一组用于导航和知识提取的工具。包括一个可视化SVG渲染器、OpenAI驱动的板分析和一个交互式CLI。
特性
- 6个MCP工具 用于板导航:概述、框架、集群、连接、搜索、完整序列化
- 交互式CLI --从列表、渲染、导出、分析、统计中选择电路板
- 空间聚类 --使用DBSCAN对附近的元素进行分组
- 文本序列化 --针对LLM优化的板到结构化文本
- 视觉渲染 --使用交互式平移/缩放查看器生成SVG/HTML
- 董事会分析 -可选GPT-4o支持的分析和交互式聊天(需要OpenAI API密钥)
- 缓存 --具有5分钟TTL的内存缓存
- 只读 --永远不要修改你的电路板
需求
- Node.js 18+
- Miro API代币(范围:
boards:read) - OpenAI API密钥(可选,用于板分析)
设置
git clone https://github.com/dkh-ai/miroex.git
cd miroex
npm install
cp .env.example .env编辑 .env 并添加您的Miro API令牌:
MIRO_API_TOKEN=your-token-here获取Miro API令牌
- 首选https://miro.com/app/settings/user-profile/apps
- 创建新应用程序(或使用现有应用程序)
- 资助范围
boards:read - 复制访问令牌
用法
克劳德代码(MCP服务器)
将MiroEx注册为MCP服务器:
claude mcp add miroex -e MIRO_API_TOKEN= -- npx tsx $(pwd)/src/index.ts验证:
claude mcp list现在,你可以向克劳德询问你的米罗板:
Read miro board and extract all decisionsShow the connection graph on board Search board for everything related to "architecture"交互式CLI
npm run cli显示您的电路板列表,然后让您选择一个操作:
- 渲染(HTML查看器) --浏览器中的交互式可视化
- 渲染(仅SVG) --矢量文件
- 导出(JSON+文本) --原始数据+文本序列化+可选LLM分析
- 分析 --GPT-4o分析与互动跟进聊天
- 董事会信息 --元素和帧统计
您可以直接传递板ID或Miro URL:
npm run cli --
npm run cli -- https://miro.com/app/board/uXjVN.../CLI实用程序
| 命令 | 描述 |
|---|---|
npm run cli | 交互式菜单 |
npx tsx src/render.ts | 将电路板渲染为HTML(在浏览器中打开) |
npx tsx src/render.ts --svg-only | 渲染为SVG文件 |
npx tsx src/_export.ts | 导出数据(JSON+文本+可选分析) |
MCP工具
| 工具 | 说明 |
|---|---|
miro_read_board | 董事会概述:元数据、统计数据、框架列表 |
miro_get_frame_content | 使用集群和连接构建内容 |
miro_get_clusters | 所有元素的空间集群 |
miro_get_connections | 带上下文的完整连接器图 |
miro_search | 全面内容的文本搜索 |
miro_get_board_as_text | 全板序列化为结构化文本 |
配置
| 变量 | 来源 | 描述 | 必填 |
|---|---|---|---|
MIRO_API_TOKEN | .env 或env | Miro API的承载令牌 | 是 |
OPENAI_API_KEY | .env 或env | 用于板分析的OpenAI API密钥 | 否 |
发展
npm run dev # MCP server in dev mode (tsx, auto-reload)
npm run build # Compile TypeScript to dist/
npm start # Run compiled version
npm run render # Visual rendering (CLI)
npm run cli # Interactive menu依赖项
| 包装 | 用途 |
|---|---|
@modelcontextprotocol/sdk | MCP协议——McpServer、StdioServerTransport |
@inquirer/prompts | 交互式CLI提示(选择、输入) |
openai | 用于板分析的OpenAI API客户端 |
zod | MCP工具输入的模式验证 |
dotenv | 从以下位置加载变量 .env |
故障排除
| 问题 | 解决方案 |
|---|---|
MIRO_API_TOKEN is not set | 检查你的 .env 通过env文件或传递: MIRO_API_TOKEN=xxx npm run cli |
| MCP服务器没有响应 | 用验证 claude mcp list。如果需要,请重新添加。 |
boards:read 权限错误 | 确保您的Miro应用程序具有 boards:read 范围 |
| 找不到板 | 检查板ID。您可以使用完整的Miro URL。 |
| 分析不起作用 | 设置 OPENAI_API_KEY 在 .env。分析是可选的。 |
tsx 未找到 | 运行 npm install 安装开发依赖项 |
| 生成错误 | 运行 npm run build 并检查TypeScript错误 |
许可证
麻省理工学院
