miro-mcp

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Using Miro with Claude Code

结合Claude Code使用Miro

What is Miro MCP?

什么是Miro MCP？

Miro MCP (Model Context Protocol) enables Claude to interact directly with Miro boards. Create diagrams, documents, and tables; read board content; and extract structured documentation from visual designs.

Miro MCP（Model Context Protocol，模型上下文协议）允许Claude直接与Miro看板进行交互。你可以创建图表、文档和表格，读取看板内容，并从视觉设计中提取结构化文档。

Available Tools

可用工具

Content Creation

内容创建

diagram_get_dsl
- Get the DSL format specification before creating diagrams
diagram_create
- Generate diagrams from DSL text descriptions
doc_create
- Create markdown documents on boards
table_create
- Create tables with text and select columns
table_sync_rows
- Add or update table rows

diagram_get_dsl
- 创建图表前获取DSL格式规范
diagram_create
- 根据DSL文本描述生成图表
doc_create
- 在看板上创建Markdown文档
table_create
- 创建包含文本和下拉选择列的表格
table_sync_rows
- 添加或更新表格行

Content Reading

内容读取

board_list_items
- List items on a board with filtering by type or container
context_explore
- Discover high-level board contents (frames, documents, prototypes, tables, diagrams)
context_get
- Extract detailed text context from specific board items
table_list_rows
- Read table data with column-based filtering
image_get_data
- Get image content from boards
image_get_url
- Get download URL for an image

board_list_items
- 按类型或容器筛选，列出看板上的项目
context_explore
- 查看看板的高层级内容（框架、文档、原型、表格、图表）
context_get
- 从特定看板项目中提取详细文本上下文
table_list_rows
- 按列值筛选读取表格数据
image_get_data
- 获取看板上的图片内容
image_get_url
- 获取图片的下载链接

Document Editing

文档编辑

doc_get
- Read document content and version
doc_update
- Edit document using find-and-replace

doc_get
- 读取文档内容和版本信息
doc_update
- 通过查找替换编辑文档

Board URLs and IDs

看板链接与ID

Miro tools accept board URLs directly. Extract board_id and item_id automatically from URLs like:

https://miro.com/app/board/uXjVK123abc=/

- Board URL

https://miro.com/app/board/uXjVK123abc=/?moveToWidget=3458764612345

- URL with item focus

When a URL includes

moveToWidget

focusWidget

parameters, the item_id is extracted automatically.

Miro工具可直接接受看板链接。会自动从以下格式的链接中提取board_id和item_id：

https://miro.com/app/board/uXjVK123abc=/

- 看板链接

https://miro.com/app/board/uXjVK123abc=/?moveToWidget=3458764612345

- 带项目焦点的链接

当链接包含

moveToWidget

或

focusWidget

参数时，item_id会被自动提取。

Creating Diagrams

创建图表

Use

diagram_create

to create visual diagrams from text descriptions.

使用

diagram_create

根据文本描述创建可视化图表。

Supported Diagram Types

支持的图表类型

flowchart - Process flows, workflows, decision trees
mindmap - Hierarchical ideas, brainstorming
uml_class - Class structures, inheritance relationships
uml_sequence - Interactions between components over time
entity_relationship - Database schemas, data models

flowchart - 流程流、工作流、决策树
mindmap - 层级化想法、头脑风暴图
uml_class - 类结构、继承关系图
uml_sequence - 组件间时序交互图
entity_relationship - 数据库 schema、数据模型图

Description Formats

描述格式

Natural language works well:

User registration flow: start -> enter email -> validate email ->
send verification -> user confirms -> create account -> redirect to dashboard

Mermaid notation for precise control:

flowchart TD
    A[Start] --> B{Valid Email?}
    B -->|Yes| C[Send Verification]
    B -->|No| D[Show Error]
    C --> E[Wait for Confirm]
    E --> F[Create Account]

自然语言描述即可：

用户注册流程: 开始 -> 输入邮箱 -> 验证邮箱 ->
发送验证邮件 -> 用户确认 -> 创建账户 -> 跳转到仪表盘

使用Mermaid语法可实现精准控制：

flowchart TD
    A[开始] --> B{邮箱有效?}
    B -->|是| C[发送验证邮件]
    B -->|否| D[显示错误]
    C --> E[等待用户确认]
    E --> F[创建账户]

Positioning Items on the Board

看板上的项目定位

Board coordinates use a Cartesian system with center at

(0, 0)

. Positive X goes right, positive Y goes down.

Spacing recommendations:

Diagrams: 2000-3000 units apart
Documents: 500-1000 units apart
Tables: 1500-2000 units apart

看板坐标采用笛卡尔坐标系，原点为

(0, 0)

。X轴正方向向右，Y轴正方向向下。

间距建议：

图表：间距2000-3000单位
文档：间距500-1000单位
表格：间距1500-2000单位

Placing in Frames

放入框架中

Set

parent_id

to a frame ID to place content inside that frame.

将

parent_id

设置为框架ID，即可将内容放入该框架内。

Creating Documents

创建文档

Use

doc_create

to create Google Docs-style documents on boards.

使用

doc_create

在看板上创建类Google Docs风格的文档。

Supported Markdown

支持的Markdown语法

Headings:
```
# H1
```
through
```
###### H6
```
Bold:
```
**text**
```
Italic:
```
*text*
```
Unordered lists:
```
- item
```
Ordered lists:
```
1. item
```
Links:
```
[text](url)
```

标题：
```
# H1
```
至
```
###### H6
```
粗体：
```
**文本**
```
斜体：
```
*文本*
```
无序列表：
```
- 项目
```
有序列表：
```
1. 项目
```
链接：
```
[文本](链接地址)
```

Example Document

文档示例

markdown

undefined

markdown

undefined

Sprint Planning - Week 12

第12周迭代规划

Goals

目标

Complete user authentication module
Fix critical bugs from QA

完成用户认证模块
修复QA提出的关键Bug

Team Assignments

团队分配

Alice - Auth backend
Bob - Frontend integration
Carol - Bug fixes

Alice - 认证后端开发
Bob - 前端集成
Carol - Bug修复

Resources

参考资源

undefined

undefined

Working with Tables

表格操作

Creating Tables

创建表格

Use

table_create

to create tables with typed columns. Supports two column types: text for free-form entry and select for dropdowns with predefined color-coded options.

使用

table_create

创建带类型列的表格。支持两种列类型：text用于自由输入，select用于带预定义颜色编码选项的下拉菜单。

Adding and Updating Rows

添加与更新行

Use

table_sync_rows

to add or update table data. Set

key_column

to match existing rows for upsert behavior — matching rows are updated, non-matching rows are inserted as new.

使用

table_sync_rows

添加或更新表格数据。设置

key_column

来匹配现有行以实现更新插入行为——匹配的行会被更新，不匹配的行会作为新行插入。

Reading Table Data

读取表格数据

Use

table_list_rows

to read table contents. Filter by column value using

ColumnName=Value

format.

使用

table_list_rows

读取表格内容。可使用

列名=值

的格式按列值筛选。

Extracting Board Content

提取看板内容

Discovering Board Contents

查看看板整体内容

Use

context_explore

to get a high-level view of what's on a board — returns frames, documents, prototypes, tables, and diagrams with their URLs and titles.

使用

context_explore

获取看板的高层级概览——返回框架、文档、原型、表格和图表的链接与标题。

Getting Item Details

获取项目详情

Use

context_get

to extract detailed content from specific items:

Item Type	Returns
Documents	HTML markup of the document content
Prototype screens	HTML markup representing the UI/layout
Prototype containers	AI-generated map of all screens with navigation flow
Frames	AI-generated summary of frame contents
Tables	Formatted table data
Diagrams	AI-generated description and analysis

使用

context_get

提取特定项目的详细内容：

项目类型	返回内容
文档	文档内容的HTML标记
原型页面	代表UI/布局的HTML标记
原型容器	AI生成的全页面导航流程图
框架	AI生成的框架内容摘要
表格	格式化的表格数据
图表	AI生成的图表描述与分析

Workflow

操作流程

Call
```
context_explore
```
to discover board contents
Identify items of interest from the results
Call
```
context_get
```
with specific item URLs (with moveToWidget parameter)

调用
```
context_explore
```
查看看板内容
从结果中确定感兴趣的项目
使用带moveToWidget参数的项目链接调用
```
context_get
```

Browsing Board Items

浏览看板项目

Use

board_list_items

to explore board contents. Filter by item type (frame, sticky_note, card, shape, text, image, document, embed) or by container to list items within a specific frame.

使用

board_list_items

浏览看板内容。可按项目类型（框架、便签、卡片、形状、文本、图片、文档、嵌入内容）筛选，或按容器筛选列出特定框架内的项目。

Best Practices

最佳实践

For Diagrams

图表相关

Be specific about elements and relationships
Specify flow direction (top-down, left-right)
Include decision points and conditions
Let AI auto-detect diagram type or specify explicitly

明确说明元素和关系
指定流向（自上而下、自左向右）
包含决策点和条件
可让AI自动检测图表类型，或明确指定

For Documents

文档相关

Structure with clear headings
Keep content focused and scannable
Use lists for multiple items
Include links to related resources

用清晰的标题构建结构
内容聚焦且易于扫描
用列表呈现多个项目
包含相关资源的链接

For Tables

表格相关

Choose meaningful column names
Use select columns for status/priority fields
Define clear, distinct option colors
Use key_column for idempotent updates

选择有意义的列名
状态/优先级字段使用select列
定义清晰、区分度高的选项颜色
使用key_column实现幂等更新

For Context Extraction

上下文提取相关

Start with
```
context_explore
```
to discover board contents
Focus on specific frames when boards are large
Use
```
context_get
```
with item URLs for detailed content

先调用
```
context_explore
```
查看看板内容
看板较大时，聚焦于特定框架
使用带项目链接的
```
context_get
```
获取详细内容

Quick Reference

快速参考

Task	Tool
Get diagram DSL spec	`diagram_get_dsl`
Create diagram	`diagram_create`
Create document	`doc_create`
Read document	`doc_get`
Edit document	`doc_update`
Create table	`table_create`
Add/update table rows	`table_sync_rows`
Read table data	`table_list_rows`
Discover board contents	`context_explore`
Extract item details	`context_get`
List board items	`board_list_items`
Get image data	`image_get_data`
Get image URL	`image_get_url`

任务	工具
获取图表DSL规范	`diagram_get_dsl`
创建图表	`diagram_create`
创建文档	`doc_create`
读取文档	`doc_get`
编辑文档	`doc_update`
创建表格	`table_create`
添加/更新表格行	`table_sync_rows`
读取表格数据	`table_list_rows`
查看看板内容	`context_explore`
提取项目详情	`context_get`
列出看板项目	`board_list_items`
获取图片数据	`image_get_data`
获取图片链接	`image_get_url`