Allows AI agents to draw, edit, and manage architecture diagrams on a live canvas or via code files.
Also known as Vrun-design/openflowkit, openflowkit, @vrun-design/openflowkit-mcp
- Stars
- 981
- Tools
- 29
- Downloads, 30 days
- —
- Latest version
- 0.2.1
- Last commit
- Nov 7, 2026
- License
- MIT
What is OpenFlowKit MCP?
OpenFlowKit allows AI agents to draw, edit, and manage architecture diagrams on a live canvas or via code files. It exposes 29 tools, such as validate_openflow_dsl, analyze_codebase, list_starter_templates.
Summary generated from the project's README
About OpenFlowKit MCP server
OpenFlowKit provides a way for AI agents to create and manage architecture diagrams through a live canvas or code files. It is designed for developers using MCP clients like Claude Code, Cursor, or Claude Desktop. The server allows an agent to draw, restyle, and take screenshots of diagrams to verify its own work. It supports various diagram types including sequence diagrams, flowcharts, ERDs, and mind maps using a single domain-specific language.
Users can connect local agents to a live canvas or use the tools to edit .openflow.json files directly within a repository. For mapping existing codebases, the tool can ingest a GitHub repository to generate a visual map where every connection is linked to specific lines of code. While public repositories can be mapped without extra steps, private repositories require a read-only GitHub token or a local checkout via the CLI. The system is local-first and open source.
What you can do with it
- 1Generate live architecture diagramsAsk an AI agent to draw and restyle a diagram on your active canvas in real time.
- 2Map a GitHub repositoryProvide a repository name to receive a visual map where arrows are cited to specific lines of code.
- 3Convert existing diagram formatsTransform Mermaid, Structurizr, or D2 code into editable canvas elements.
- 4Create animated technical documentationAdd animation blocks to diagram text to export animated SVGs, GIFs, or MP4s.
Written from the project's README. Every use case is checked against a quote from it.
How to install OpenFlowKit MCP
Formats verified 10 Nov 2026Add to CursorAdd to GooseInstall OpenFlowKit MCP in Claude Code
$ claude mcp add openflowkit -- npx -y @vrun-design/openflowkit-mcpInstall OpenFlowKit MCP in Cursor
~/.cursor/mcp.json
{
"mcpServers": {
"openflowkit": {
"command": "npx",
"args": [
"-y",
"@vrun-design/openflowkit-mcp"
]
}
}
}Install OpenFlowKit MCP in VS Code
.vscode/mcp.json
{
"servers": {
"openflowkit": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@vrun-design/openflowkit-mcp"
]
}
}
}Install OpenFlowKit MCP in VS Code CLI
$ code --add-mcp '{"name":"openflowkit","type":"stdio","command":"npx","args":["-y","@vrun-design/openflowkit-mcp"]}'Install OpenFlowKit MCP in Claude Desktop
claude_desktop_config.json
{
"mcpServers": {
"openflowkit": {
"command": "npx",
"args": [
"-y",
"@vrun-design/openflowkit-mcp"
]
}
}
}Install OpenFlowKit MCP in Codex
$ codex mcp add openflowkit -- npx -y @vrun-design/openflowkit-mcpInstall OpenFlowKit MCP in Codex config.toml
~/.codex/config.toml
[mcp_servers.openflowkit] command = "npx" args = ["-y", "@vrun-design/openflowkit-mcp"]
Install OpenFlowKit MCP in Gemini CLI
$ gemini mcp add -s user openflowkit npx -- -y @vrun-design/openflowkit-mcpInstall OpenFlowKit MCP in Gemini settings.json
~/.gemini/settings.json
{
"mcpServers": {
"openflowkit": {
"command": "npx",
"args": [
"-y",
"@vrun-design/openflowkit-mcp"
]
}
}
}Started by HostedMCP on 16 Nov 2026
We ran this command for @vrun-design/openflowkit-mcp 0.2.1 in an isolated container with no network and no keys. It answered and listed 29 tools.
OpenFlowKit MCP tools 29
Read from the server with tools/listvalidate_openflow_dslParse and compile OpenFlow DSL — or Mermaid, Structurizr DSL or D2, converted first — and return structured diagnostics (code, severity, line, column, message, hint), the same check as `openflowkit validate`. `ok` is false on any error: text that cannot be drawn, or a line the parser could not read (create_diagram would draw without it). Warnings name guesses (an unknown word, a misspelled header) that still draw. For another language, `converted.dsl` is what it became and `converted.losses` name the lines of your text that did not carry over; diagnostics then refer to `converted.dsl`.
analyze_codebaseWalk a directory on disk and report detected cloud platform, services, top-level structure, and language breakdown. No network access — pure local filesystem scan. Useful to seed an architecture diagram.
list_starter_templatesList built-in OpenFlow starter templates that can be loaded without any AI call. Returns names, titles, categories, and one-line summaries.
get_starter_templateReturn the OpenFlow DSL for a named starter template. Use list_starter_templates to discover available names.
list_diagram_node_typesQuick reference for the OpenFlow DSL vocabulary: family names, shape words, edge arrows, and the wireframe controls and screen frames. Call get_syntax for the full grammar.
server_infoReturn the server version and the tools, resources and prompts it serves. Useful when debugging client connections.
discover_architectureWalk a local repo (compose, Dockerfiles, k8s, terraform, package manifests, datastore and HTTP-client usage) and return a proposed OFK C4 workspace as DSL, with evidence per unit. Deterministic, offline; review the proposal before committing it.
drift_reportCompare an architecture model (inline dsl, a documentId, or else architecture.ofk in path) against a repository. Returns missing (in repo, not in model), undrawn (in model, no repo evidence) and changed (name matches, tech or dir differs) with evidence lines.
explain_elementEverything known about one element: the model entry, its relations, repository evidence (when a path is given) and the ADR markdown files its links point at.
openflow_createCreate an empty file-mode document in this process.
openflow_openLoad a canonical document from disk into file mode and return its id.
openflow_saveWrite a document to disk (svg: true also writes the first page as a .svg beside it). With a paired editor and no documentId, saves what the editor currently shows.
| validate_openflow_dsl | Parse and compile OpenFlow DSL — or Mermaid, Structurizr DSL or D2, converted first — and return structured diagnostics (code, severity, line, column, message, hint), the same check as `openflowkit validate`. `ok` is false on any error: text that cannot be drawn, or a line the parser could not read (create_diagram would draw without it). Warnings name guesses (an unknown word, a misspelled header) that still draw. For another language, `converted.dsl` is what it became and `converted.losses` name the lines of your text that did not carry over; diagnostics then refer to `converted.dsl`. | |
| analyze_codebase | Walk a directory on disk and report detected cloud platform, services, top-level structure, and language breakdown. No network access — pure local filesystem scan. Useful to seed an architecture diagram. | |
| list_starter_templates | List built-in OpenFlow starter templates that can be loaded without any AI call. Returns names, titles, categories, and one-line summaries. | |
| get_starter_template | Return the OpenFlow DSL for a named starter template. Use list_starter_templates to discover available names. | |
| list_diagram_node_types | Quick reference for the OpenFlow DSL vocabulary: family names, shape words, edge arrows, and the wireframe controls and screen frames. Call get_syntax for the full grammar. | |
| server_info | Return the server version and the tools, resources and prompts it serves. Useful when debugging client connections. | |
| discover_architecture | Walk a local repo (compose, Dockerfiles, k8s, terraform, package manifests, datastore and HTTP-client usage) and return a proposed OFK C4 workspace as DSL, with evidence per unit. Deterministic, offline; review the proposal before committing it. | |
| drift_report | Compare an architecture model (inline dsl, a documentId, or else architecture.ofk in path) against a repository. Returns missing (in repo, not in model), undrawn (in model, no repo evidence) and changed (name matches, tech or dir differs) with evidence lines. | |
| explain_element | Everything known about one element: the model entry, its relations, repository evidence (when a path is given) and the ADR markdown files its links point at. | |
| openflow_create | Create an empty file-mode document in this process. | |
| openflow_open | Load a canonical document from disk into file mode and return its id. | |
| openflow_save | Write a document to disk (svg: true also writes the first page as a .svg beside it). With a paired editor and no documentId, saves what the editor currently shows. |
Show all 29 toolsShow fewer tools
whoamiLocal-only status: whether an editor is paired, and the documents this server holds.
create_diagramDraw a new diagram frame from text, placed right of what the page already holds (or at `at`). One undo step. To change a diagram that exists, use update_diagram with its frameId instead of drawing another.
update_diagramRedraw an existing diagram frame from new text, in place: same frame id and position, one undo step (a C4 workspace redraws every view page it owns). The text replaces the frame, as Generate in the code panel does, so canvas edits it does not carry (get_diagram lists them as `canvasEdits`) are dropped; `discarded` names any that were, each with its frameId.
get_diagramThe DSL text of one diagram frame: what was authored while the canvas still matches it, else text regenerated from the canvas (`edited: true`). `canvasEdits` lists what was changed on the canvas against the authored text: recolours, moves, resizes, renames, icons, rewired or bent connectors, and shapes added or removed. Each has `carry`: attributes to merge into that node's existing `[ … ]` list (one list per node) to keep the edit, or null when the language cannot say it. `canvasEdits` is null, with `canvasEditsNote` saying why, when it could not be compared. `losses` names what the language cannot say at all. update_diagram drops anything the text you send does not carry.
list_diagramsEvery diagram frame in the document: frameId, page, family, title, and `edited` (the canvas no longer matches its text).
get_syntaxThe OpenFlow DSL grammar: the full reference, or one family’s section.
search_iconsSearch the shipped icon packs by name (e.g. "lambda", "sql database"). Use the returned provider/slug in DSL `icon:` attributes.
find_icons_forConcept search ("cache", "queue", "auth") expanded into catalog queries and ranked; the fastest way to pick icon ids for architecture DSL.
moveMove nodes on the canvas, by `delta`, or so the first id lands at `to` (the rest keep their offsets). Pass exactly one of the two. One undo step. A diagram regenerated from text lays its nodes out again.
styleSet fill, stroke, stroke width, dash, opacity or text colour on nodes, or move the icon on icon cards (iconPlacement). Pass at least one property. One undo step. A diagram regenerated from text drops these unless its DSL carries them (get_diagram lists them as canvasEdits).
deleteDelete nodes (with their children and the connectors attached to them) or connectors, by id. One undo step.
add_shapeAdd one shape without writing DSL (hand-layout only). Prefer create_diagram. Kinds: rectangle, ellipse, text, rounded, capsule, circle, diamond, triangle, trapezoid, parallelogram, hexagon, octagon, pentagon-tag, chevron, plus, star, heart, cloud, lightning, bookmark, speech-bubble, page, folder, list-card, filled-bar, half-round, cylinder, document, cube, prism, layer-stack, target, check-circle, cross-circle, numbered-circle, brace, bracket, pin, actor, arrow-up, arrow-down, arrow-left, arrow-right, venn, process, start, decision, end, custom, image, annotation, sticky, callout, pen, highlighter, line, arrow, architecture, provider_icon, group, section, swimlane, class, er_entity, mindmap, journey, sequence_participant, sequence_note, sequence_fragment, browser, mobile, chart, widget (wireframe control), frame (phone, browser… preset; drop widgets in with parentId).
exportExport the document, a page, or a selection as SVG, PNG, PDF (print HTML), JSON, or an animation (animated SVG, GIF, MP4, WebM). Returns the file bodies. Raster animation needs a live editor (WebCodecs); a file host serves animated SVG only.
screenshotA PNG image of one diagram frame, or of the whole page, to check your work by eye. Needs a live editor (the user clicks "Connect agent").
fit_viewPoint the live editor's camera at one diagram frame, some ids, or (with neither) the whole page. Changes the view only, not the document.
get_documentNodes and connectors of one page, with ids, labels and geometry, plus `selection`: the ids the user has selected on that page in the live editor ("the box I selected"; empty in file mode or when nothing is selected). Use get_diagram for a diagram's DSL.
list_pagesEvery page in the document with its shape counts and diagram kind.
| whoami | Local-only status: whether an editor is paired, and the documents this server holds. | |
| create_diagram | Draw a new diagram frame from text, placed right of what the page already holds (or at `at`). One undo step. To change a diagram that exists, use update_diagram with its frameId instead of drawing another. | |
| update_diagram | Redraw an existing diagram frame from new text, in place: same frame id and position, one undo step (a C4 workspace redraws every view page it owns). The text replaces the frame, as Generate in the code panel does, so canvas edits it does not carry (get_diagram lists them as `canvasEdits`) are dropped; `discarded` names any that were, each with its frameId. | |
| get_diagram | The DSL text of one diagram frame: what was authored while the canvas still matches it, else text regenerated from the canvas (`edited: true`). `canvasEdits` lists what was changed on the canvas against the authored text: recolours, moves, resizes, renames, icons, rewired or bent connectors, and shapes added or removed. Each has `carry`: attributes to merge into that node's existing `[ … ]` list (one list per node) to keep the edit, or null when the language cannot say it. `canvasEdits` is null, with `canvasEditsNote` saying why, when it could not be compared. `losses` names what the language cannot say at all. update_diagram drops anything the text you send does not carry. | |
| list_diagrams | Every diagram frame in the document: frameId, page, family, title, and `edited` (the canvas no longer matches its text). | |
| get_syntax | The OpenFlow DSL grammar: the full reference, or one family’s section. | |
| search_icons | Search the shipped icon packs by name (e.g. "lambda", "sql database"). Use the returned provider/slug in DSL `icon:` attributes. | |
| find_icons_for | Concept search ("cache", "queue", "auth") expanded into catalog queries and ranked; the fastest way to pick icon ids for architecture DSL. | |
| move | Move nodes on the canvas, by `delta`, or so the first id lands at `to` (the rest keep their offsets). Pass exactly one of the two. One undo step. A diagram regenerated from text lays its nodes out again. | |
| style | Set fill, stroke, stroke width, dash, opacity or text colour on nodes, or move the icon on icon cards (iconPlacement). Pass at least one property. One undo step. A diagram regenerated from text drops these unless its DSL carries them (get_diagram lists them as canvasEdits). | |
| delete | Delete nodes (with their children and the connectors attached to them) or connectors, by id. One undo step. | |
| add_shape | Add one shape without writing DSL (hand-layout only). Prefer create_diagram. Kinds: rectangle, ellipse, text, rounded, capsule, circle, diamond, triangle, trapezoid, parallelogram, hexagon, octagon, pentagon-tag, chevron, plus, star, heart, cloud, lightning, bookmark, speech-bubble, page, folder, list-card, filled-bar, half-round, cylinder, document, cube, prism, layer-stack, target, check-circle, cross-circle, numbered-circle, brace, bracket, pin, actor, arrow-up, arrow-down, arrow-left, arrow-right, venn, process, start, decision, end, custom, image, annotation, sticky, callout, pen, highlighter, line, arrow, architecture, provider_icon, group, section, swimlane, class, er_entity, mindmap, journey, sequence_participant, sequence_note, sequence_fragment, browser, mobile, chart, widget (wireframe control), frame (phone, browser… preset; drop widgets in with parentId). | |
| export | Export the document, a page, or a selection as SVG, PNG, PDF (print HTML), JSON, or an animation (animated SVG, GIF, MP4, WebM). Returns the file bodies. Raster animation needs a live editor (WebCodecs); a file host serves animated SVG only. | |
| screenshot | A PNG image of one diagram frame, or of the whole page, to check your work by eye. Needs a live editor (the user clicks "Connect agent"). | |
| fit_view | Point the live editor's camera at one diagram frame, some ids, or (with neither) the whole page. Changes the view only, not the document. | |
| get_document | Nodes and connectors of one page, with ids, labels and geometry, plus `selection`: the ids the user has selected on that page in the live editor ("the box I selected"; empty in file mode or when nothing is selected). Use get_diagram for a diagram's DSL. | |
| list_pages | Every page in the document with its shape counts and diagram kind. |
Automated checks
Ran Nov 16, 2026Full report →Passed our automated checks. That is not a security audit: read the code and give the server the narrowest access it needs. How checks work · What to fix for more points
- Source repository linked and reachablevrun-design/openflowkit is public and reachablegithub.com/vrun-design/openflowkit ↗Pass
- Package names this repository as its source@vrun-design/openflowkit-mcp names vrun-design/openflowkit as sourcenpmjs.com/package/@vrun-design/openflowkit-mcp ↗Pass
- Build provenance (Sigstore attestation)No build attestation published for this releaseNot checked
- Open source license (OSI)MITspdx.org/licenses/MIT.html ↗Pass
- Commit or release in the last yearLast commit or release 2026-11-07github.com/vrun-design/openflowkit ↗Pass
- OpenSSF ScorecardNot checked
- Package name not close to a popular packageNo popular package one edit away from @vrun-design/openflowkit-mcpPass
- No critical advisory in the package or its dependencies100 resolved dependencies checked; no critical advisoryosv.dev ↗Pass
- No hidden instructions to the model29 tool descriptions and the README read; no override phrases, credential paths or hidden charactersPass
- Destructive tools are labelleddelete has no destructiveHintFinding
- Remote endpoint answers the MCP handshakeNot checked
README
View on GitHubWhy OpenFlowKit
1. Your agent draws on your canvas, live
Connect Claude Code, Cursor or any MCP client and ask for a diagram. The agent reads the page, draws, restyles and takes a screenshot to check its own work while you watch. Every change it makes is one undo step, like your own. Connect your agent ↓
2. Text and canvas are the same diagram
flowchart right
Client [blue] -> "API Gateway" [emerald] : HTTPS
"API Gateway" -> Queue [queue, amber]
Queue -> Worker
Worker -> Store [cylinder, red, bold]
Open the code panel (⌥C), paste this into it and press ⌘↵. Drag things around on the canvas or edit the text; ⌘↵ regenerates the frame from the text as one undo step. Paste Mermaid, Structurizr or D2 and it converts.
3. Paste a GitHub repo, get its map
Type owner/repo into the box on an empty canvas and press Map repo, or open
app.openflowkit.com/#/map/github/<owner>/<repo>
(try a sample).
Your browser reads the repo from GitHub and draws its parts. Boxes open in place, and every
arrow lists the file:line behind it, linked to the code. No key and no install. For a private
repo, add a read-only GitHub token on the page, or map a checkout: npx openflowkit map . --html map.html
(private repos).
4. Export it, including the animation
PNG, SVG, PDF, JSON, or Copy as Mermaid for a README. Add an animate block to the text
above to name the steps, and the export renders animated SVG, GIF, MP4 or WebM in your browser.
animate build 6s loop {
step Client
step Client -> "API Gateway" : HTTPS
step Queue, Worker
step Store hold 2s
}
That animation is the two snippets above, exported by the app as an animated SVG. GitHub plays it like an image.
Ten diagram types, one language
Every type is the same short, forgiving text, with per-line errors that say how to fix them.
Each picture below is the first example on its docs page, rendered by the openflowkit CLI.
The language is versioned and written down in one file: src/dsl/grammar.md (docs). The same text powers the code panel, the assistant, the MCP tools and the CLI.
Quick start
In the browser: app.openflowkit.com. Nothing to install, no account.
In a terminal: npx openflowkit (Node 20.11+).
Run it locally (Node 22.22+):
git clone https://github.com/openflowkit/openflowkit.git
cd openflowkit
npm install && npm run dev # http://localhost:3000
Connect your agent
OpenFlowKit has one set of agent tools. Pick the row for where your agent runs:
| Your agent runs… | How to connect | What it can do |
|---|---|---|
| On your computer: Claude Code, Cursor, VS Code, Claude Desktop, Windsurf | The MCP server, below | Everything: draws on your open canvas (one undo step per change), edits .openflow.json files in your repo, maps a codebase, takes screenshots |
| In a chat app: claude.ai, Claude Desktop, ChatGPT | Add a custom connector: https://mcp.openflowkit.com/mcp, choose No sign-in |
Draws a diagram in the chat as a card, with Open in OpenFlowKit. Not on your open canvas |
| In your browser (experimental) | Nothing to install: open a diagram in a browser whose agent supports WebMCP | Reads and edits the diagram you have open |
For Claude Code, one line:
claude mcp add -s user openflowkit -- npx -y openflowkit mcp
For Codex: codex mcp add openflowkit -- npx -y openflowkit mcp.
For Claude Desktop, Windsurf and any other MCP client:
{
"mcpServers": {
"openflowkit": { "command": "npx", "args": ["-y", "openflowkit", "mcp"] }
}
}
Restart the agent, then click Connect agent in the app, or open
app.openflowkit.com/#/connect. That panel has the steps for each client
and copies the same config with a pairing token. With no app open, the same tools edit .openflow.json files in
your repo. Every client, step by step, with fixes: Connect your agent.
# Claude Code
claude plugin marketplace add openflowkit/openflowkit
claude plugin install openflowkit@openflowkit
# Codex: add the marketplace, then install OpenFlowKit from the Plugins Directory
codex plugin marketplace add openflowkit/openflowkit
The skill (skills/openflowkit/SKILL.md) tells an agent when a
diagram helps, how to write it, and to save it beside the code. Agents that read the web get the
same text at https://app.openflowkit.com/llms.txt.
Working with agents
The MCP server gives your agent the operations you have, on the live canvas or on files.
| It can | With |
|---|---|
| Draw a diagram from text or Mermaid, then change it | create_diagram, update_diagram, add_shape |
| Read every page, the text behind a diagram, and what you selected | get_document, get_diagram, list_pages |
| Restyle and move what is already there | style, move, delete |
| See its own result | screenshot returns a real image the model can look at |
| Hand you files | export: SVG, PNG, PDF, JSON or an animated SVG |
| Read your repo | discover_architecture, drift_report, explain_element |
Things to ask for:
- "Draw the architecture of this repository."
- "Make the boxes I selected red and add a cache in front of the API."
- "Turn the Mermaid in our README into a diagram I can edit."
- "Compare architecture.ofk with the code and tell me what drifted."
Your canvas edits are safe: if you moved, restyled or renamed something and the agent regenerates
from text, get_diagram hands it the text that keeps each edit, and update_diagram reports
anything it had to drop. Every agent change is one undo step, and the Connect panel shows the
last one with an Undo button.
Sixteen editor operations, which also work on files: create_diagram, update_diagram,
get_diagram, list_diagrams, get_syntax, search_icons, find_icons_for, move, style,
delete, add_shape, export, screenshot, fit_view, get_document, list_pages.
Thirteen for files and repositories: openflow_create, openflow_open, openflow_save, whoami,
server_info, validate_openflow_dsl, list_diagram_node_types, list_starter_templates,
get_starter_template, analyze_codebase, discover_architecture, drift_report,
explain_element.
Arguments and examples: MCP server docs. The op
manifest is src/agent/manifest.ts. Requires Node 20.11+.
Bring your own key instead: ⌘J opens the assistant. Pick Claude, OpenAI, Gemini, Groq, Mistral, Cerebras, NVIDIA, OpenRouter, Ollama or any OpenAI-compatible endpoint (LM Studio…) and paste a key. The key stays in this browser, and the reply arrives as a proposal you apply or dismiss.
Bring the diagrams you already have
Paste into the code panel and it converts, with an honest list of anything it couldn't carry. Mermaid pasted straight onto the canvas draws in place.
| From | What converts |
|---|---|
| Mermaid | flowchart / graph, sequenceDiagram, stateDiagram, erDiagram, classDiagram, mindmap, architecture, gitGraph |
| Structurizr DSL | the model, views and styles, as a C4 workspace with one page per view |
| D2 | shapes, connections and containers |
Going back out, Copy as Mermaid writes a flowchart or sequence diagram as Mermaid text for a README or wiki. Mermaid · coming from Structurizr
In your repo and CI
The openflowkit CLI runs the same engine as the app, from any terminal or CI job:
npx openflowkit render diagram.ofk -o diagram.svg # Mermaid, D2, Structurizr or DSL → SVG
npx openflowkit validate diagram.ofk --strict # exit 1 on an error
npx openflowkit convert flow.mmd -o flow.openflow.json
npx openflowkit discover . --out architecture.ofk # draft a C4 model of this repo
npx openflowkit drift . # exit 1 when the code moved on
Commit architecture.ofk next to the code and drift keeps it honest in CI. The PR diagrams
Action comments on a pull request with how its diagrams changed: node and connector counts, the
text diff, and drift for .ofk models.
CLI · GitHub Action
Exports and sharing
| Format | Notes |
|---|---|
| PNG | 1× or 2×; light, dark or print theme; transparent background optional |
| SVG, PDF | vector, with icons and the Inter font embedded |
| JSON | the whole document, every page; opens in any browser |
| Animated SVG, GIF, MP4, WebM | made in your browser from the animate block or the connector order |
| Copy as Mermaid | flowchart and sequence |
| Share links | a view-only link, encrypted in your browser; or an editable copy, the code inside the link, nothing uploaded |
Keyboard
Every action has a key, and ? lists them all in the app.
| Key | Action |
|---|---|
| V R O T A | select, rectangle, ellipse, text, connector |
| ⌥C · ⌘↵ | code panel · generate from text |
| ⌘J | AI assistant |
| M | switch Canvas and Map |
| ⌘F | find on the canvas |
| ⇧1 · ⇧2 | fit everything · zoom to selection |
| ⌘G · ⌘D | group · duplicate |
| Enter | edit the selected shape's label |
On Windows and Linux, Ctrl and Alt replace ⌘ and ⌥.
How it works
This diagram is OpenFlowKit text too: how-it-works.ofk, exported as an animated SVG with the pulse preset.
You and your agent can also draw straight on the canvas; every edit, from text or by hand, is a command on the same document.
Any frame on the canvas writes back out as canonical text, and format(format(x)) == format(x)
holds in the tests. The language and document code is plain TypeScript with no React, Pixi or
DOM, which is why the same compiler runs in the browser, the MCP server and the CLI. The full
tour: ARCHITECTURE.md.
| Path | What |
|---|---|
src/dsl/ |
the language: grammar, parser, diagram families, compile and serialize, repo discovery |
src/opencanvas/ |
the editor: document model and commands, Pixi renderer, exporters, React UI |
src/agent/ |
the operations agents call, the bridge protocol, the op manifest |
mcp-server/ |
the published MCP server and openflowkit CLI |
cli/ |
openflowkit on npm: the short name for the CLI |
plugin/, skills/ |
the Claude Code and Codex plugins, and the agent skill |
action/ |
the PR diagrams GitHub Action |
worker/ |
the share-link Worker (stores ciphertext only) |
stats/ |
the private usage dashboard Worker |
docs-site/ |
the docs site |
Self-host
docker build -t openflowkit . && docker run --rm -p 3045:3045 openflowkit # http://localhost:3045
The image is the static build behind nginx, with the same headers as the hosted app. Content security policy, AI providers on your own network, and share links: self-hosting.
Privacy
Your diagrams stay in your browser. Something leaves it only when you choose: AI with your own key goes to that provider, a share link uploads an encrypted copy, a repo map reads from GitHub. No account needed. We collect basic usage stats to improve OpenFlowKit; turn them off in Settings. Back up everything at once with Download all diagrams on Home; Import restores it in any browser.
Is it free? Yes: MIT licensed, free to use and to self-host. A Pro plan for teams is planned; the waitlist is in the app.
Does it work offline? Once the page is open, drawing, the code panel and exports run in the page. AI, share links and repo maps need the network. For no internet at all, self-host it.
Which browsers? A current desktop browser with WebGL. The automated tests run in Chromium.
Can my team edit together? Not in real time. A view-only link is a snapshot, an editable
link hands each person their own copy, and .openflow.json and .ofk files live happily in git.
More: FAQ.
Contributing
Issues, ideas and PRs are welcome. Start with CONTRIBUTING.md for setup and the checks, and ARCHITECTURE.md for how the code fits together. Questions go to Discussions. What changed in each version: CHANGELOG.md.
Report security issues privately, as SECURITY.md describes. MIT licensed, see LICENSE.
OpenFlowKit MCP questions
How do I add OpenFlowKit MCP to Claude Code?
Run claude mcp add openflowkit -- npx -y @vrun-design/openflowkit-mcp in your terminal. Add --scope user to make it available in every project.
How do I add OpenFlowKit MCP to Cursor?
Open ~/.cursor/mcp.json and add the server under mcpServers, using the Cursor config shown in the install section above.
What tools does OpenFlowKit MCP provide?
It exposes 29 tools, including validate_openflow_dsl, analyze_codebase, list_starter_templates, get_starter_template, list_diagram_node_types.
Can an AI agent draw diagrams for me?
Yes, you can connect Claude Code, Cursor, or any MCP client to let the agent draw, restyle, and take screenshots of diagrams on a live canvas.
How do I map a GitHub repository to a diagram?
You can type the owner/repo into the canvas box or use the CLI to map a local checkout to generate a map where every arrow is linked to specific lines of code.
Can I use this with private GitHub repositories?
Yes, you can add a read-only GitHub token on the page or use the CLI to map a local checkout.