← 返回 Skills 市场

ISAI Mermaid Diagrams

Name: ISAI Mermaid Diagrams
Author: opietaylor911

作者 OpieTaylor911 · GitHub ↗ · v1.0.0 · MIT-0

cross-platform ✓ 安全检测通过

248

总下载

当前安装

版本数

在 OpenClaw 中安装

/install isai-mermaid-diagrams

功能描述

Generate architecture diagrams (network, system, cloud, microservices) and sequence diagrams (API flows, auth flows, data flows) as PNG files using Mermaid....

使用说明 (SKILL.md)

Mermaid Diagrams Skill

Generates Mermaid diagrams and renders them to PNG using the mmdc CLI.

Reference Files

Architecture patterns (flowchart, C4, cloud, network, microservices) → references/architecture-patterns.md
Sequence diagram patterns (API flows, auth, CI/CD, DLP flows) → references/sequence-patterns.md

Load the relevant reference file based on diagram type requested.

Rendering Tool

Use mermaid.ink (free online renderer, no browser/install needed):

mkdir -p /home/bcaddy/.openclaw/workspace/diagrams
ENCODED=$(cat \x3Cinput.mmd> | base64 -w 0)
curl -s "https://mermaid.ink/img/${ENCODED}?bgColor=white&width=2048" \
  -o /home/bcaddy/.openclaw/workspace/diagrams/\x3Cname>.png

Output directory: /home/bcaddy/.openclaw/workspace/diagrams/
Width: 2048px default; increase for very wide diagrams (&width=3000)
Always create output directory first: mkdir -p /home/bcaddy/.openclaw/workspace/diagrams

Workflow

1. Identify Diagram Type

Network/system/cloud/microservices → use flowchart or C4Context
API/auth/data flows, step-by-step processes → use sequenceDiagram
When in doubt: sequence for "how does X work step by step", architecture for "what does X look like"

2. Load Reference File

Architecture → references/architecture-patterns.md
Sequence → references/sequence-patterns.md

3. Generate Mermaid Code

Write complete, valid Mermaid syntax
Use descriptive node labels (not just A, B, C)
Use subgraphs to group related components in architecture diagrams
Use alt/loop/note blocks to add clarity in sequence diagrams
Match the style of the patterns in the reference file

4. Save .mmd File

Save to: /home/bcaddy/.openclaw/workspace/diagrams/\x3Cdescriptive-name>.mmd

Use kebab-case, descriptive filenames: auth-flow.mmd, aws-architecture.mmd, api-gateway-sequence.mmd

5. Render to PNG via mermaid.ink

ENCODED=$(cat /home/bcaddy/.openclaw/workspace/diagrams/\x3Cname>.mmd | base64 -w 0)
curl -s "https://mermaid.ink/img/${ENCODED}?bgColor=white&width=2048" \
  -o /home/bcaddy/.openclaw/workspace/diagrams/\x3Cname>.png

6. Confirm Output

Report the full path to the saved PNG. Offer to adjust layout, add components, or generate a .mmd file for further editing in mermaid.live or VS Code.

Tips

flowchart LR for left-to-right pipelines and network flows
flowchart TD for top-down hierarchies and cloud stacks
Wide diagrams: increase -w (width); tall diagrams: increase -H (height)
For very complex diagrams, break into multiple diagrams
Always include a title comment at the top of the .mmd file: %% Title: ...

安全使用建议

This skill appears to do what it says: create .mmd and render PNGs. Important things to consider before installing/using: - Privacy: Rendering is done by posting the base64-encoded Mermaid source to mermaid.ink. Do not use this skill to render diagrams that contain secrets, credentials, internal hostnames/IPs, or other sensitive information unless you are comfortable sending them to that external service. Consider sanitizing diagrams first. - If you need offline or private rendering, install/use the official mermaid-cli (mmdc) locally or host your own Mermaid rendering endpoint and change the curl target to that host. - Path: The SKILL.md hardcodes /home/bcaddy/.openclaw/workspace/diagrams/. Ensure the agent's runtime user has a writable workspace, or update the path to your environment. The example base64 command uses GNU base64 flags (-w 0) which may differ on non-Linux systems (macOS's base64 uses -b on some builds); adjust accordingly. - Trust and retention: Review mermaid.ink's privacy policy/retention practices if you plan to render sensitive diagrams. If you accept the above (i.e., you will not send sensitive diagrams to a public renderer or you will self-host), the skill is coherent and reasonable to use. If you require strict confidentiality, consider switching to a local renderer before using this skill.

功能分析

Type: OpenClaw Skill Name: isai-mermaid-diagrams Version: 1.0.0 The skill is designed to generate and render Mermaid diagrams into PNG files using the public mermaid.ink API. It uses standard shell commands (curl, base64, mkdir) to encode diagram syntax and retrieve the rendered image, which is then stored in a local workspace directory. The behavior is transparent, well-documented, and aligns perfectly with the stated purpose of creating technical visualizations (architecture, sequence, and flow diagrams) without any evidence of malicious intent or unauthorized data access.

能力评估

✓ Purpose & Capability

Name/description match the instructions: the SKILL.md explains how to generate Mermaid (.mmd) files and render them to PNG via a renderer. The required capabilities (none) are proportionate. One minor mismatch: the instructions use a hardcoded path (/home/bcaddy/.openclaw/workspace/diagrams/) which assumes a specific username/environment and may not exist on all hosts.

⚠ Instruction Scope

Runtime instructions explicitly transmit the Mermaid source (base64-encoded) to https://mermaid.ink/img/ via curl. That is functionally required to render remotely but means any diagram content (which may include internal architecture, IPs, or secrets if present in labels) is sent to a third party. The skill does not request other unrelated files or credentials.

✓ Install Mechanism

Instruction-only skill with no install spec or bundled code; nothing is written to disk by an installer. Lower install risk.

ℹ Credentials

The skill does not request environment variables or credentials (good). It does rely on an absolute filesystem path (/home/bcaddy/...); that is unnecessary to require a specific home directory and could cause failures or unexpected file placements in different environments.

✓ Persistence & Privilege

always is false and the skill has no install script, no permissions or persistence requested, and does not modify other skills or global settings.

如何使用

确保已安装 OpenClaw（本地或 Docker 部署）
在对话框中输入安装命令：/install isai-mermaid-diagrams
安装完成后，直接呼叫该 Skill 的名称或使用 /isai-mermaid-diagrams 触发
根据 Skill 的参数说明提供必要输入，即可获得结构化输出

版本历史

v1.0.0

Initial release — generate architecture diagrams (network, system, cloud, microservices) and sequence diagrams (API flows, auth flows, CI/CD) as PNG using mermaid.ink renderer. No local browser required.

元数据

Slug isai-mermaid-diagrams

版本 1.0.0

许可证 MIT-0

累计安装 0

当前安装数 0

历史版本数 1

常见问题