Skip to content
Skills Library
Programming · Building & coding

openflowkit

/openflowkit

Draw diagrams that stay valid, editable and saved next to the code. Use when a flowchart, architecture, sequence, state, ER, class, mindmap or git graph would explain something better than prose, or when the user asks for a diagram. Needs the openflowkit MCP server.

Repository
openflowkit ↗
Licence
MIT
Last repository change
07.11.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
1
Scripts
0
HTML comments
0
URLs in SKILL.md
1
Deprecation

No signals detected. Repository changed on 07.11.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

Draw diagrams that stay valid, editable and saved next to the code. Use when a flowchart, architecture, sequence, state, ER, class, mindmap or git graph would explain something better than prose, or when the user asks for a diagram. Needs the openflowkit MCP server.

Original author description

Draw diagrams that stay valid, editable and saved next to the code. Use when a flowchart, architecture, sequence, state, ER, class, mindmap or git graph would explain something better than prose, or when the user asks for a diagram. Needs the openflowkit MCP server.

How it works

  1. Setup (once)
  2. Draw and save
  3. Change a diagram
  4. Draw this repo's architecture
  5. OpenFlow DSL in one screen
  6. Mermaid works too
  7. Rules
Original SKILL.md headings · 116 lines, 765 words
SKILL.md preview
---
name: openflowkit
description: Draw diagrams that stay valid, editable and saved next to the code. Use when a flowchart, architecture, sequence, state, ER, class, mindmap or git graph would explain something better than prose, or when the user asks for a diagram. Needs the openflowkit MCP server.
---

# OpenFlowKit diagrams

Write Mermaid or OpenFlow DSL, hand it to the `openflowkit` MCP server, and save the result as a
`.openflow.json` beside the code it explains: it opens at app.openflowkit.com (Open file) and reads back.

**When to draw:** a flow with branches, a system with more than three moving parts, a protocol,
a data model, a state machine. Not a list, a single call, or what one sentence explains.

## Setup (once)

`claude mcp add -s user openflowkit -- npx -y openflowkit mcp` (any MCP client: `npx -y openflowkit mcp`); it
calls no outside service. In claude.ai or ChatGPT, `https://mcp.openflowkit.com/mcp` draws chat cards only.

## Draw and save

1. Write the diagram in Mermaid (what you already know) or OpenFlow DSL (below).
2. `validate_openflow_dsl` with `{ dsl }` until `ok`. Fix every `error`: a line the parser dropped is one,
   with its line and a hint. Warnings are guesses; read them. For Mermaid (or Structurizr DSL, D2),
   `converted.losses` name what did not carry over and `converted.dsl` is what it became.
3. With an editor paired (`whoami`; if not, ask the user to open app.openflowkit.com/#/connect),
   `create_diagram` with `{ dsl }` draws where the user is looking. Otherwise use file mode:
   `openflow_create`, then `create_diagram` with `{ dsl, documentId }`.
4. `openflow_save` with `{ path }` (plus `documentId` in file mode) beside the code, e.g.
   `src/payments/checkout-flow.openflow.json`; `svg: true` also writes a `.svg` (for a README).
5. Tell the user the path, and what you left out.

## Change a diagram

`get_diagram` returns the DSL and `frameId` (file mode: `openflow_open`, then pass `documentId`) → edit the
text → `update_diagram` with `{ frameId, dsl }` → `openflow_save`, not `create_diagram` (a second diagram).
The redraw drops `canvasEdits` (the user's recolours, moves, renames) unless you merge each `carry` into
that node's one `[ … ]` list; `discarded` lists any lost. To re-read, `since: <revision>` gives `dslDiff`:
only the canvas changes, canonically numbered. "The box I selected" is `selection` in `get_document`.

## Draw this repo's architecture

`discover_architecture` with `{ path }` proposes a C4 workspace (`dsl`) from the code. Review its
names, `create_diagram` with it, and write the text to `architecture.ofk` at the repo root; later,
`drift_report` with `{ path }` says what the code gained or lost since.

## OpenFlow DSL in one screen

First line is the family: `flowchart`, `architecture`, `sequence`, `state`, `erd`, `class`,
`mindmap`, `gitgraph`, optionally with a direction (`flowchart right`). Lines are statements;
`//` starts a comment. Nodes are declared by name; edges declare their ends.

```dsl
flowchart right
title: Checkout
group Payments {
  Pay [diamond]
  Stripe [icon: tabler/brand-stripe]
}
Cart -> Pay : card ok?
Pay -> Done [ellipse, green] : yes
Pay --> Cart : no [red]
Pay -> Stripe : charge [thick]
```

- Arrows: `->` solid, `-->` dashed, `<->` both ends, `--` no heads, `A -> B : label`.
- Attributes go in `[ … ]`: a shape, a colour, a fill, flags, or `key: value`.
- Shapes: `rect rounded circle ellipse diamond cylinder hexagon cloud doc note parallelogram person queue component browser mobile`
- Colours: `blue green red orange violet teal pink yellow gray` or `#hex`.
- Icons: `icon: aws/lambda`, `gcp/pubsub`, `tech/react`, `tabler/user`. A node whose label names a
  technology (`Postgres`, `Redis`, `S3 bucket`) gets its icon by itself; `icon: none` stops it.
  `iconpos: left` draws an icon card as a row, the icon beside its name. `search_icons` finds exact ids.
- `group Name { … }` boxes the nodes first mentioned inside it, so open groups before edges.
  An edge to `Name` ends on the group itself.
  `note Name : text` pins a sticky to a node.

```dsl
sequence
participant Browser [person]
Browser -> API : POST /login
API -> DB : find user
DB --> API : row
alt valid {
  API --> Browser : 200 + token
} else invalid {
  API --> Browser : 401
}
```

```dsl
erd
users {
  id uuid pk
  email text unique
}
orders {
  id uuid pk
  user_id uuid fk
}
users ||--o{ orders : places
```

For any other family, or more detail, call `get_syntax` with the family name.

## Mermaid works too

```mermaid
flowchart LR
  A[Client] -->|HTTPS| B(API)
  B --> C[(Postgres)]
```

Converts: flowchart, sequenceDiagram, stateDiagram, classDiagram, erDiagram, mindmap, architecture-beta,
gitGraph; not gantt, pie, journey (write `chart bar` DSL, see `get_syntax`). Structurizr and D2 text convert too.

## Rules

- One diagram per idea; split before forty nodes. Name nodes as the code does (`OrderService`).
- Do not place coordinates; layout is computed. Change the text and `update_diagram`.
- Check before you claim: `validate_openflow_dsl` passes, then save, then report the path.

Versions

RepositoryScoreLicence
This page · openflowkit/openflowkit100MIT
openflowkit/openflowkit100MIT

Database snapshot: 13.11.2026 · package version 22d04f7b5b62 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100generating-diagrams
    Use when generating flowcharts, diagrams, dependency graphs, or visual representations of processes, relationships, architecture, or state machines. Triggers: 'diagram this', 'flowchart', 'visualize', 'dependency graph', 'ER diagram', 'state machine diagram', 'class diagram',…
  • 90diagrams:mermaid
    Produce a Mermaid diagram (flowchart, sequence, class, state, ER, gantt, pie, mindmap) inside a ```mermaid fenced code block for rendering in Markdown, docs, or the GitHub/GitLab viewer. Use when the user asks for a mermaid diagram, a flowchart/sequence/class/state/ER/gantt…
  • 100visual-communication
    Communicate systems and flows visually using Mermaid (flowchart, sequence, state, ER, class), the C4 model, and diagram-as-code. Use when the user asks to draw a flow, sequence diagram, state machine, ER diagram, C4 model, architecture diagram, or wants Mermaid code for a…
  • 90flow
    Draw and iterate on Mermaid diagrams the user watches live in the Flow viewer, and handle their node comments. Use when the user asks for a diagram, flowchart, architecture sketch, sequence, state machine, ER diagram, or says "flow", or when Flow feedback arrives.
  • 98architecture-diagram
    仅在用户要求基于 Python 项目源码分析并生成软件架构图、时序图或端到端链路图时使用,包括模块分层、调用关系和可交互下钻。Use when a user asks to analyze a Python codebase and create source-grounded software architecture, sequence, or end-to-end flow diagrams, including module layers, call relationships, and interactive drill-down.…
  • 90doncheli-diagram
    Auto-generate Mermaid or C4 diagrams from code analysis. Activate when user mentions "diagram", "mermaid", "architecture diagram", "C4", "class diagram", "sequence diagram", "ERD", "flowchart", "visualize code".

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.