flowzap-mcp 1.0.4 → 1.0.6

package/README.md

@@ -2,9 +2,17 @@
 
 Create workflow diagrams using AI assistants like Claude, Cursor, and Windsurf.
 
+[FlowZap](https://flowzap.xyz) 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](https://flowzap.xyz) is a visual workflow diagramming tool with a text-based DSL called **FlowZap Code**. This MCP server lets AI assistants create diagrams for you.
+FlowZap turns text prompts into dual-view diagrams (Flowchart & Sequence diagrams) 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)`
 
 ## Installation
 
@@ -29,11 +37,11 @@ Config file locations:
 
 ### For Cursor
 
-Add to your Cursor MCP settings with the same configuration.
+Add the same configuration to your Cursor MCP settings.
 
 ### For Windsurf IDE
 
-Add to your `~/.codeium/windsurf/mcp_config.json`:
+Add to `~/.codeium/windsurf/mcp_config.json`:
 
 ```json
 {
@@ -46,16 +54,18 @@ Add to your `~/.codeium/windsurf/mcp_config.json`:
 }
 ```
 
-## Available Tools
-
-### `flowzap_validate`
-Validate FlowZap Code syntax before creating a diagram.
+> **Windows Users:** If tools don't appear, use the absolute path:
+> ```json
+> "command": "C:\\Program Files\\nodejs\\npx.cmd"
+> ```
 
-### `flowzap_create_playground`
-Create a shareable playground URL with your diagram.
+## Available Tools
 
-### `flowzap_get_syntax`
-Get FlowZap Code syntax documentation and examples.
+| Tool | Description |
+|------|-------------|
+| `flowzap_validate` | Validate FlowZap Code syntax |
+| `flowzap_create_playground` | Create a shareable diagram URL |
+| `flowzap_get_syntax` | Get FlowZap Code syntax documentation |
 
 ## Usage Examples
 
@@ -73,65 +83,39 @@ The assistant will:
 ## FlowZap Code Example
 
 ```
-sales {
-  # Sales Team
+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"]
-  n3.handle(bottom) -> n6.handle(top) [label="No"]
-  n6: rectangle label:"Reject Order"
 }
 
-fulfillment {
-  # Fulfillment
+fulfillment { # Fulfillment
   n4: rectangle label:"Process Order"
   n5: circle label:"Complete"
   n4.handle(right) -> n5.handle(left)
 }
 ```
 
-**Key syntax rules:**
-- **Node IDs**: Must be `n1`, `n2`, `n3`... (globally unique, sequential)
-- **Shapes**: Only `circle`, `rectangle`, `diamond`, `taskbox`
-- **Node attributes**: Use colon → `label:"Text"`
-- **Edge labels**: Use equals in brackets → `[label="Yes"]`
-- **Edges**: Must use handles → `n1.handle(right) -> n2.handle(left)`
-- **Cross-lane**: Prefix with lane name → `fulfillment.n4.handle(left)`
-
 ## Security
 
-This MCP server implements comprehensive security measures:
-
-### What It Does
-- **Only calls official FlowZap APIs** - Hardcoded to `https://flowzap.xyz` only
-- **No authentication required** - Uses only public, anonymous endpoints
-- **No user data access** - Cannot read your diagrams, account, or any private data
-- **Runs locally** - The server runs on your machine, not exposed to the internet
-
-### Security Features
-- **SSRF Protection** - URL whitelist prevents requests to unauthorized hosts
-- **Input Validation** - Code size limits (50KB max), sanitization of control characters
-- **Rate Limiting** - Client-side rate limiting (30 requests/minute)
-- **Request Timeout** - 30-second timeout prevents hanging connections
-- **Response Sanitization** - Only expected fields are returned from API responses
-- **Error Handling** - Internal errors are logged but not exposed to clients
-- **Tool Whitelisting** - Only explicitly defined tools can be called
-
-### What It Cannot Do
-- Access your FlowZap account or saved diagrams
-- Modify any existing data
-- Make requests to any domain other than flowzap.xyz
-- Store any credentials or tokens
+- **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
 
 ## Links
 
 - [FlowZap Website](https://flowzap.xyz)
 - [FlowZap Code Documentation](https://flowzap.xyz/flowzap-code)
+- [LLM Context](https://flowzap.xyz/llms.txt)
+- [Templates Library](https://flowzap.xyz/templates)
 - [npm Package](https://www.npmjs.com/package/flowzap-mcp)
-- [MCP Registry](https://registry.modelcontextprotocol.io)
+- [GitHub Repository](https://github.com/flowzap-xyz/flowzap-mcp)
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flowzap-mcp",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "mcpName": "io.github.flowzap-xyz/flowzap",
   "description": "MCP server for FlowZap - Create workflow diagrams via AI assistants",
   "main": "dist/index.js",