miro-automation

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Miro Automation via Rube MCP

通过Rube MCP实现Miro自动化

Automate Miro whiteboard operations through Composio's Miro toolkit via Rube MCP.

通过Composio的Miro工具包，借助Rube MCP自动化Miro白板操作。

Prerequisites

前提条件

Rube MCP must be connected (RUBE_SEARCH_TOOLS available)
Active Miro connection via
```
RUBE_MANAGE_CONNECTIONS
```
with toolkit
```
miro
```
Always call
```
RUBE_SEARCH_TOOLS
```
first to get current tool schemas

必须已连接Rube MCP（需具备RUBE_SEARCH_TOOLS功能）
通过
```
RUBE_MANAGE_CONNECTIONS
```
并使用工具包
```
miro
```
建立有效的Miro连接
请始终先调用
```
RUBE_SEARCH_TOOLS
```
获取最新的工具架构

Setup

设置步骤

Get Rube MCP: Add

https://rube.app/mcp

as an MCP server in your client configuration. No API keys needed — just add the endpoint and it works.

Verify Rube MCP is available by confirming
```
RUBE_SEARCH_TOOLS
```
responds
Call
```
RUBE_MANAGE_CONNECTIONS
```
with toolkit
```
miro
```
If connection is not ACTIVE, follow the returned auth link to complete Miro OAuth
Confirm connection status shows ACTIVE before running any workflows

获取Rube MCP：在客户端配置中添加

https://rube.app/mcp

作为MCP服务器。无需API密钥 —— 只需添加端点即可使用。

确认
```
RUBE_SEARCH_TOOLS
```
能正常响应，以此验证Rube MCP可用
调用
```
RUBE_MANAGE_CONNECTIONS
```
并指定工具包
```
miro
```
如果连接状态未显示为ACTIVE，请按照返回的授权链接完成Miro OAuth认证
在运行任何工作流之前，确认连接状态显示为ACTIVE

Core Workflows

核心工作流

1. List and Browse Boards

1. 列出和浏览看板

When to use: User wants to find boards or get board details

Tool sequence:

```
MIRO_GET_BOARDS2
```
- List all accessible boards [Required]
```
MIRO_GET_BOARD
```
- Get detailed info for a specific board [Optional]

Key parameters:

```
query
```
: Search term to filter boards by name
```
sort
```
: Sort by 'default', 'last_modified', 'last_opened', 'last_created', 'alphabetically'
```
limit
```
: Number of results per page (max 50)
```
offset
```
: Pagination offset
```
board_id
```
: Specific board ID for detailed retrieval

Pitfalls:

Pagination uses offset-based approach, not cursor-based
Maximum 50 boards per page; iterate with offset for full list
Board IDs are long alphanumeric strings; always resolve by search first

适用场景：用户想要查找看板或获取看板详情

工具调用序列:

```
MIRO_GET_BOARDS2
```
- 列出所有可访问的看板 [必填]
```
MIRO_GET_BOARD
```
- 获取特定看板的详细信息 [可选]

关键参数:

```
query
```
: 用于按名称过滤看板的搜索词
```
sort
```
: 排序方式，可选'default'、'last_modified'、'last_opened'、'last_created'、'alphabetically'
```
limit
```
: 每页结果数量（最大50）
```
offset
```
: 分页偏移量
```
board_id
```
: 用于获取详情的特定看板ID

注意事项:

分页采用基于偏移量的方式，而非游标式
每页最多显示50个看板；如需获取完整列表，请通过偏移量迭代查询
看板ID为长字符串的字母数字组合；请始终先通过搜索获取看板ID

2. Create Boards and Items

2. 创建看板与项目

When to use: User wants to create a new board or add items to an existing board

Tool sequence:

```
MIRO_CREATE_BOARD
```
- Create a new empty board [Optional]
```
MIRO_CREATE_STICKY_NOTE_ITEM
```
- Add sticky notes to a board [Optional]
```
MIRO_CREATE_FRAME_ITEM2
```
- Add frames to organize content [Optional]
```
MIRO_CREATE_ITEMS_IN_BULK
```
- Add multiple items at once [Optional]

Key parameters:

```
name
```
/
```
description
```
: Board name and description (for CREATE_BOARD)
```
board_id
```
: Target board ID (required for all item creation)
```
data
```
: Content object with
```
content
```
field for sticky note text
```
style
```
: Styling object with
```
fillColor
```
for sticky note color
```
position
```
: Object with
```
x
```
and
```
y
```
coordinates
```
geometry
```
: Object with
```
width
```
and
```
height
```

Pitfalls:

```
board_id
```
is required for ALL item operations; resolve via GET_BOARDS2 first
Sticky note colors use hex codes (e.g., '#FF0000') in the
```
fillColor
```
field
Position coordinates use the board's coordinate system (origin at center)
BULK create has a maximum items-per-request limit; check current schema
Frame items require
```
geometry
```
with both width and height

适用场景：用户想要创建新看板或向现有看板添加项目

工具调用序列:

```
MIRO_CREATE_BOARD
```
- 创建新的空白看板 [可选]
```
MIRO_CREATE_STICKY_NOTE_ITEM
```
- 向看板添加便签 [可选]
```
MIRO_CREATE_FRAME_ITEM2
```
- 添加框架以组织内容 [可选]
```
MIRO_CREATE_ITEMS_IN_BULK
```
- 批量添加多个项目 [可选]

关键参数:

```
name
```
/
```
description
```
: 看板的名称和描述（适用于CREATE_BOARD）
```
board_id
```
: 目标看板ID（所有项目创建操作均必填）
```
data
```
: 包含
```
content
```
字段的内容对象，用于存储便签文本
```
style
```
: 包含
```
fillColor
```
字段的样式对象，用于设置便签颜色
```
position
```
: 包含
```
x
```
和
```
y
```
坐标的位置对象
```
geometry
```
: 包含
```
width
```
和
```
height
```
的尺寸对象

注意事项:

```
board_id
```
是所有项目操作的必填项；请先通过GET_BOARDS2获取
便签颜色需使用十六进制代码（例如'#FF0000'）填写在
```
fillColor
```
字段中
位置坐标采用看板的坐标系（原点位于中心）
批量创建请求有最大项目数量限制；请查看最新架构确认
框架项目需要同时填写
```
geometry
```
中的宽度和高度

3. Browse and Manage Board Items

3. 浏览与管理看板项目

When to use: User wants to view, find, or organize items on a board

Tool sequence:

```
MIRO_GET_BOARD_ITEMS
```
- List all items on a board [Required]
```
MIRO_GET_CONNECTORS2
```
- List connections between items [Optional]

Key parameters:

```
board_id
```
: Target board ID (required)
```
type
```
: Filter by item type ('sticky_note', 'shape', 'text', 'frame', 'image', 'card')
```
limit
```
: Number of items per page
```
cursor
```
: Pagination cursor from previous response

Pitfalls:

Results are paginated; follow
```
cursor
```
until absent for complete item list
Item types must match Miro's predefined types exactly
Large boards may have thousands of items; use type filtering to narrow results
Connectors are separate from items; use GET_CONNECTORS2 for relationship data

适用场景：用户想要查看、查找或组织看板上的项目

工具调用序列:

```
MIRO_GET_BOARD_ITEMS
```
- 列出看板上的所有项目 [必填]
```
MIRO_GET_CONNECTORS2
```
- 列出项目之间的连接线 [可选]

关键参数:

```
board_id
```
: 目标看板ID（必填）
```
type
```
: 按项目类型过滤，可选'sticky_note'、'shape'、'text'、'frame'、'image'、'card'
```
limit
```
: 每页项目数量
```
cursor
```
: 上一次响应返回的分页游标

注意事项:

结果采用分页方式；请跟随
```
cursor
```
直到无更多结果或游标不存在
项目类型必须与Miro预定义的类型完全匹配
大型看板可能包含数千个项目；请使用类型过滤缩小结果范围
连接线与项目是分开的；如需获取关系数据，请使用GET_CONNECTORS2

4. Share and Collaborate on Boards

4. 共享看板与协作

When to use: User wants to share a board with team members or manage access

Tool sequence:

```
MIRO_GET_BOARDS2
```
- Find the board to share [Prerequisite]
```
MIRO_SHARE_BOARD
```
- Share the board with users [Required]
```
MIRO_GET_BOARD_MEMBERS
```
- Verify current board members [Optional]

Key parameters:

```
board_id
```
: Board to share (required)
```
emails
```
: Array of email addresses to invite
```
role
```
: Access level ('viewer', 'commenter', 'editor')
```
message
```
: Optional invitation message

Pitfalls:

Email addresses must be valid; invalid emails cause the entire request to fail
Role must be one of the predefined values; case-sensitive
Sharing with users outside the organization may require admin approval
GET_BOARD_MEMBERS returns all members including the owner

适用场景：用户想要与团队成员共享看板或管理访问权限

工具调用序列:

```
MIRO_GET_BOARDS2
```
- 找到需要共享的看板 [前置步骤]
```
MIRO_SHARE_BOARD
```
- 与用户共享看板 [必填]
```
MIRO_GET_BOARD_MEMBERS
```
- 验证当前看板成员 [可选]

关键参数:

```
board_id
```
: 要共享的看板ID（必填）
```
emails
```
: 邀请用户的邮箱地址数组
```
role
```
: 访问权限级别，可选'viewer'、'commenter'、'editor'
```
message
```
: 可选的邀请消息

注意事项:

邮箱地址必须有效；无效邮箱会导致整个请求失败
权限级别必须是预定义的值，且区分大小写
与组织外部用户共享可能需要管理员审批
GET_BOARD_MEMBERS会返回包括所有者在内的所有成员

5. Create Visual Connections

5. 创建可视化连接线

When to use: User wants to connect items on a board with lines or arrows

Tool sequence:

```
MIRO_GET_BOARD_ITEMS
```
- Find items to connect [Prerequisite]
```
MIRO_GET_CONNECTORS2
```
- View existing connections [Optional]

Key parameters:

```
board_id
```
: Target board ID
```
startItem
```
: Object with
```
id
```
of the source item
```
endItem
```
: Object with
```
id
```
of the target item
```
style
```
: Connector style (line type, color, arrows)

Pitfalls:

Both start and end items must exist on the same board
Item IDs are required for connections; resolve via GET_BOARD_ITEMS first
Connector styles vary; check available options in schema
Self-referencing connections (same start and end) are not allowed

适用场景：用户想要用线条或箭头连接看板上的项目

工具调用序列:

```
MIRO_GET_BOARD_ITEMS
```
- 找到需要连接的项目 [前置步骤]
```
MIRO_GET_CONNECTORS2
```
- 查看现有连接线 [可选]

关键参数:

```
board_id
```
: 目标看板ID
```
startItem
```
: 包含源项目
```
id
```
的对象
```
endItem
```
: 包含目标项目
```
id
```
的对象
```
style
```
: 连接线样式（线条类型、颜色、箭头）

注意事项:

起始项目和结束项目必须位于同一个看板上
连接线需要项目ID；请先通过GET_BOARD_ITEMS获取
连接线样式有多种选项；请查看架构确认可用选项
不允许创建自引用连接线（起始和结束项目为同一项目）

Common Patterns

常见模式

ID Resolution

ID解析

Board name -> Board ID:

1. Call MIRO_GET_BOARDS2 with query=board_name
2. Find board by name in results
3. Extract id field

Item lookup on board:

1. Call MIRO_GET_BOARD_ITEMS with board_id and optional type filter
2. Find item by content or position
3. Extract item id for further operations

看板名称 -> 看板ID:

1. 调用MIRO_GET_BOARDS2并传入query=board_name
2. 在结果中按名称查找看板
3. 提取id字段

看板上的项目查找:

1. 调用MIRO_GET_BOARD_ITEMS并传入board_id和可选的类型过滤器
2. 按内容或位置查找项目
3. 提取项目id以进行后续操作

Pagination

分页处理

Boards: Use
```
offset
```
and
```
limit
```
(offset-based)
Board items: Use
```
cursor
```
and
```
limit
```
(cursor-based)
Continue until no more results or cursor is absent
Default page sizes vary by endpoint

看板：使用
```
offset
```
和
```
limit
```
（基于偏移量）
看板项目：使用
```
cursor
```
和
```
limit
```
（基于游标）
持续查询直到无更多结果或游标不存在
默认每页数量因端点而异

Coordinate System

坐标系说明

Board origin (0,0) is at the center
Positive X is right, positive Y is down
Items positioned by their center point
Use
```
position: {x: 0, y: 0}
```
for center of board
Frames define bounded areas; items inside inherit frame position

看板原点(0,0)位于中心位置
X轴正方向为右，Y轴正方向为下
项目按其中心点定位
使用
```
position: {x: 0, y: 0}
```
将项目置于看板中心
框架定义了边界区域；框架内的项目会继承框架的位置

Known Pitfalls

已知注意事项

Board IDs:

Board IDs are required for virtually all operations
Always resolve board names to IDs via GET_BOARDS2 first
Do not hardcode board IDs; they vary by account

Item Creation:

Each item type has different required fields
Sticky notes need
```
data.content
```
for text
Frames need
```
geometry.width
```
and
```
geometry.height
```
Position defaults to (0,0) if not specified; items may overlap

Rate Limits:

Miro API has rate limits per token
Bulk operations preferred over individual item creation
Use MIRO_CREATE_ITEMS_IN_BULK for multiple items

Response Parsing:

Response data may be nested under
```
data
```
key
Item types determine which fields are present in response
Parse defensively; optional fields may be absent

看板ID:

几乎所有操作都需要看板ID
请始终先通过GET_BOARDS2将看板名称解析为ID
请勿硬编码看板ID；不同账号的看板ID不同

项目创建:

不同类型的项目有不同的必填字段
便签需要
```
data.content
```
来存储文本
框架需要
```
geometry.width
```
和
```
geometry.height
```
如果未指定位置，默认会置于(0,0)；项目可能会重叠

速率限制:

Miro API对每个令牌有速率限制
优先使用批量操作而非逐个创建项目
如需添加多个项目，请使用MIRO_CREATE_ITEMS_IN_BULK

响应解析:

响应数据可能嵌套在
```
data
```
键下
项目类型决定了响应中会出现哪些字段
请采用防御式解析；可选字段可能不存在

Quick Reference

快速参考

Task	Tool Slug	Key Params
List boards	MIRO_GET_BOARDS2	query, sort, limit, offset
Get board details	MIRO_GET_BOARD	board_id
Create board	MIRO_CREATE_BOARD	name, description
Add sticky note	MIRO_CREATE_STICKY_NOTE_ITEM	board_id, data, style, position
Add frame	MIRO_CREATE_FRAME_ITEM2	board_id, data, geometry, position
Bulk add items	MIRO_CREATE_ITEMS_IN_BULK	board_id, items
Get board items	MIRO_GET_BOARD_ITEMS	board_id, type, cursor
Share board	MIRO_SHARE_BOARD	board_id, emails, role
Get members	MIRO_GET_BOARD_MEMBERS	board_id
Get connectors	MIRO_GET_CONNECTORS2	board_id

任务	工具标识	关键参数
列出看板	MIRO_GET_BOARDS2	query, sort, limit, offset
获取看板详情	MIRO_GET_BOARD	board_id
创建看板	MIRO_CREATE_BOARD	name, description
添加便签	MIRO_CREATE_STICKY_NOTE_ITEM	board_id, data, style, position
添加框架	MIRO_CREATE_FRAME_ITEM2	board_id, data, geometry, position
批量添加项目	MIRO_CREATE_ITEMS_IN_BULK	board_id, items
获取看板项目	MIRO_GET_BOARD_ITEMS	board_id, type, cursor
共享看板	MIRO_SHARE_BOARD	board_id, emails, role
获取成员列表	MIRO_GET_BOARD_MEMBERS	board_id
获取连接线	MIRO_GET_CONNECTORS2	board_id