mcpField
L
lark-whiteboard

lark-whiteboard

larksuiteAgent workflows17.9k472.5k installsUpdated today
Repository

About lark-whiteboard

lark-whiteboard is an Agent Skill for Lark whiteboards, operated through a command line tool. It exports board content and writes or updates boards from Mermaid, PlantUML, or SVG input.

Key features

  1. 01Export preview images, SVG, or source code
  2. 02Write Mermaid, PlantUML, and SVG content
  3. 03Decision rules separating read-only and write operations
  4. 04Append to or overwrite existing whiteboards

Use cases

  1. 01Export a Lark whiteboard as an image or SVG
  2. 02Write existing Mermaid or PlantUML code to a board
  3. 03Draw architecture or flow diagrams from scratch

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/larksuite/cli --skill lark-whiteboard

After installing, type/lark-whiteboardin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

elements/
connectors.md
content.md
image.md
layout.md
schema.md
style.md
typography.md
references/
lark-whiteboard-export.md
lark-whiteboard-update.md
lark-whiteboard-workflow.md
routes/
dsl.md
mermaid.md
svg-edit.md
svg.md
scenes/
architecture.md
bar-chart.md
comparison.md
fishbone.md
flowchart.md
flywheel.md
funnel.md
line-chart.md
mention.md
mermaid.md
milestone.md
organization.md
photo-showcase.md
pyramid.md
swimlane.md
treemap.md

Details

From the project README

Important

  • 运行 lark-cli --version，确认可用，无需询问用户。
  • 运行 npx -y @larksuite/whiteboard-cli@^0.2.13 -v，确认可用，无需询问用户。

CRITICAL — 开始前 MUST 先用 Read 工具读取 ../lark-shared/SKILL.md，其中包含认证、权限处理

快速决策

身份：画板操作默认使用 --as user。仅当需要以应用身份上传时使用 --as bot。

先判断「只读还是写入」，再在对应表内按上到下匹配，命中即停。

A. 只读 · 查看 / 导出（不改画板）
用户需求行动
查看画板内容 / 导出图片+export --output-type preview
导出 SVG 矢量图+export --output-type svg
提取画板的 Mermaid/PlantUML 源码+export --output-type source
B. 写入 · 创作 / 编辑（会改画板，命中即停）
场景行动写入方式对原内容
用户已提供 Mermaid/PlantUML/SVG 代码，或明确指定用该格式使用该代码 → +update，--input_format 取单值 mermaid / plantuml / svg；写入非空已有画板并需要 overwrite 时，先确认会整板重建；若 SVG 用于修改已有画板，先走 routes/svg-edit.md 有损确认overwrite / append按用户要求
从零新建复杂图表（架构/流程/组织等）→ § 创作 Workflow首次写入—
修改 / 增补已有画板→ § 编辑 Workflow见该表见该表

Shortcuts

Shortcut说明
+export导出画板为预览图片、SVG 矢量图、代码或原始节点结构。
+update更新画板，支持 PlantUML、Mermaid、SVG 或 OpenAPI 原生格式

不在本 skill 范围

Comments

Markdown supported