io.github.flowzap-xyz/flowzap
Create workflow diagrams via AI assistants with FlowZap Code validation and playground URLs.
Ask AI about io.github.flowzap-xyz/flowzap
Powered by Claude Β· Grounded in docs
I know everything about io.github.flowzap-xyz/flowzap. Ask me about installation, configuration, usage, or troubleshooting.
0/500
Reviews
Documentation
FlowZap MCP Server
Create workflow, sequence, and architecture diagrams using AI assistants like Claude, Cursor, Windsurf, and 8 other MCP-compatible tools.
FlowZap is a visual workflow diagramming tool with a text-based DSL called FlowZap Code. This MCP server lets AI assistants create diagrams for you.
What is FlowZap?
FlowZap turns text prompts into triple-view diagrams (Workflow, Sequence & Architecture) using FlowZap Code DSL. It is NOT Mermaid, NOT PlantUML - it is a unique domain-specific language designed for simplicity and AI generation.
Key Facts:
- Only 4 shapes:
circle,rectangle,diamond,taskbox - Node attributes use colon:
label:"Text" - Edge labels use equals:
[label="Text"] - Handles required:
n1.handle(right) -> n2.handle(left) - Sequence diagram quality: every cross-lane request needs a matching response edge; define edges in chronological order; no orphaned nodes
Installation
The FlowZap MCP Server works with any tool that supports the Model Context Protocol (MCP):
All Compatible Coding Tools
| Tool | How to Configure |
|---|---|
| Claude Desktop | Add to claude_desktop_config.json:macOS: ~/Library/Application Support/Claude/claude_desktop_config.jsonWindows: %APPDATA%\Claude\claude_desktop_config.json |
| Claude Code | Run: claude mcp add --transport stdio flowzap -- npx -y flowzap-mcpOr add to .mcp.json in your project root. |
| Cursor | Open Settings β Features β MCP Servers β Add Server. Use the same JSON config. |
| Windsurf IDE | Add to ~/.codeium/windsurf/mcp_config.json |
| OpenAI Codex | Add to ~/.codex/config.toml:[mcp_servers.flowzap]command = "npx"args = ["-y", "flowzap-mcp"]Or run: codex mcp add flowzap -- npx -y flowzap-mcp |
| Warp Terminal | Settings β MCP Servers β Click "+ Add" β Paste the JSON config. |
| Zed Editor | Add to settings.json:{"context_servers": {"flowzap": {"command": "npx", "args": ["-y", "flowzap-mcp"]}}} |
| Cline (VS Code) | Open Cline sidebar β MCP Servers icon β Edit cline_mcp_settings.json |
| Roo Code (VS Code) | Add to .roo/mcp.json in project or global settings. |
| Continue.dev | Create .continue/mcpServers/flowzap.yaml with:name: FlowZapmcpServers: - name: flowzap command: npx args: ["-y", "flowzap-mcp"] |
| Sourcegraph Cody | Add to VS Code settings.json via openctx.providers configuration. |
Not Compatible: Replit and Lovable.dev only support remote MCP servers via URL. Use the Public API instead.
JSON Configuration
All tools use the same JSON configuration format:
{
"mcpServers": {
"flowzap": {
"command": "npx",
"args": ["-y", "flowzap-mcp"]
}
}
}
Windows Users: If tools don't appear, use the absolute path:
"command": "C:\\Program Files\\nodejs\\npx.cmd"Find your npx path with:
where.exe npx
Available Tools
Core Tools
| Tool | Description |
|---|---|
flowzap_validate | Validate FlowZap Code syntax |
flowzap_create_playground | Create a shareable diagram URL |
flowzap_get_syntax | Get FlowZap Code syntax documentation |
Agent-Focused Tools
| Tool | Description |
|---|---|
flowzap_export_graph | Export FlowZap Code as structured JSON graph (lanes, nodes, edges) for reasoning |
flowzap_artifact_to_diagram | Parse HTTP logs, OpenAPI specs, or code into FlowZap diagrams |
flowzap_diff | Compare two versions of FlowZap Code and get structured diff |
flowzap_apply_change | Apply structured patch operations (insert/remove/update nodes/edges) |
Usage Examples
Basic Diagram Creation
Ask your AI assistant:
- "Generate a Sequence diagram of the current Sign In flow implemented in this App"
- "Create a workflow diagram for an order processing system"
- "Create an architecture diagram for a microservices API gateway"
- "Make a flowchart showing user registration flow"
- "Diagram a CI/CD pipeline with build, test, and deploy stages"
Agent-Focused Workflows
Parse HTTP Logs into Diagrams:
"Here are my nginx access logs. Create a sequence diagram showing the request flow."
The agent uses flowzap_artifact_to_diagram with artifactType: "http_logs".
Analyze Diagram Structure:
"Which steps in this workflow touch the database?"
The agent uses flowzap_export_graph to get a JSON graph, then queries it.
Show What Changed:
"I updated the workflow. What's different from the previous version?"
The agent uses flowzap_diff to compare old and new code.
Safe Incremental Updates:
"Add a logging step after the API call in this diagram."
The agent uses flowzap_apply_change with a structured patch instead of regenerating.
The assistant will:
- Generate FlowZap Code based on your description
- Validate the code
- Create a playground URL with the appropriate view (workflow, sequence, or architecture) to view and share
FlowZap Code Example
sales { # Sales Team
n1: circle label:"Order Received"
n2: rectangle label:"Validate Order"
n3: diamond label:"Valid?"
n1.handle(right) -> n2.handle(left)
n2.handle(right) -> n3.handle(left)
n3.handle(right) -> fulfillment.n4.handle(left) [label="Yes"]
}
fulfillment { # Fulfillment
n4: rectangle label:"Process Order"
n5: circle label:"Complete"
n4.handle(right) -> n5.handle(left)
}
Security
- No authentication required - Uses only public FlowZap APIs
- No user data access - Cannot read your diagrams or account
- Runs locally - The MCP server runs on your machine
- SSRF protected - Only connects to flowzap.xyz
- Rate limited - 30 requests/minute client-side
- Input validation - 50KB max code size
Agent Skill (skills.sh)
Install the FlowZap skill for 40+ compatible coding agents via skills.sh:
npx skills add flowzap-xyz/flowzap-mcp
- skills.sh listing: https://skills.sh/flowzap-xyz/flowzap-mcp/flowzap-diagrams
- Skill source: skills/flowzap-diagrams/
- Compatible with: Claude Code, Cursor, Windsurf, Codex, Gemini CLI, GitHub Copilot, Cline, Roo Code, Augment, OpenCode, and more.
Links
- FlowZap Website
- FlowZap Code Documentation
- FlowZap MCP Blog
- LLM Context
- Templates Library
- npm Package
- GitHub Repository
License
MIT
