@markdy/mcp-server
v1.5.0
Published
Model Context Protocol server for Markdy diagram validation, transpilation, and generation.
Maintainers
Readme
@markdy/mcp-server
Official Model Context Protocol (MCP) server for Markdy — the animated diagram-as-code DSL.
Equip Claude Desktop, Cursor, Google Antigravity, Windsurf, and autonomous AI agents with tools to parse, validate, transpile, explain, and craft animated Markdy architecture diagrams.
⚡ Key Capabilities
| Capability | Description |
| :--- | :--- |
| 🛠️ Tools | Syntax validation with AI self-healing diagnostics, multi-format transpilation (Mermaid, Docker Compose, Kubernetes, Terraform, Draw.io), topology breakdown, and template retrieval. |
| 📦 Resources | On-demand access to the canonical specification (markdy://spec/agent-reference), Well-Architected governance rules (markdy://governance/rules), and curated architecture templates (markdy://templates/catalog). |
| 💬 Prompts | Pre-engineered prompt workflows (create_architecture_diagram, audit_architecture, transpile_architecture) that guide agents through structured diagram design. |
🚀 Client Configuration
1. Claude Desktop (claude_desktop_config.json)
{
"mcpServers": {
"markdy": {
"command": "npx",
"args": ["-y", "@markdy/mcp-server"]
}
}
}2. Cursor (.cursor/mcp.json)
{
"mcpServers": {
"markdy": {
"command": "npx",
"args": ["-y", "@markdy/mcp-server"]
}
}
}3. Google Antigravity (~/.gemini/antigravity/mcp_config.json)
{
"mcpServers": {
"markdy": {
"command": "npx",
"args": ["-y", "@markdy/mcp-server"]
}
}
}4. Windsurf (~/.codeium/windsurf/mcp_config.json)
{
"mcpServers": {
"markdy": {
"command": "npx",
"args": ["-y", "@markdy/mcp-server"]
}
}
}5. Zed (settings.json)
{
"context_servers": {
"markdy": {
"command": {
"path": "npx",
"args": ["-y", "@markdy/mcp-server"]
}
}
}
}🛠️ Provided Tools
1. validate_markdy_code
Validates MarkdyScript syntax and verifies Well-Architected governance rules (layer boundaries, cycle detection, ingress gateway enforcement). Returns structured diagnostic suggestions and an AI healing prompt if parse errors occur.
Parameters
| Parameter | Type | Presence | Default | Description |
| :--- | :--- | :--- | :--- | :--- |
| code | string | Required | None | The complete MarkdyScript diagram code starting with scene. |
| checkArchitecture | boolean | Optional | true | When true, runs Well-Architected governance lint rules. |
2. diagnose_markdy_syntax
Deep diagnostic tool that analyzes MarkdyScript syntax, performs fuzzy typo matching for keywords/node kinds/operators/nodes, identifies unquoted multi-word strings, detects flow cycle overlaps, and returns line-by-line snippets, "Did you mean?" suggestions, and proposed auto-repaired code.
Parameters
| Parameter | Type | Presence | Default | Description |
| :--- | :--- | :--- | :--- | :--- |
| code | string | Required | None | The MarkdyScript diagram code to inspect. |
| checkArchitecture | boolean | Optional | true | When true, includes governance rules in the report. |
3. fix_markdy_code
Automatically repairs common MarkdyScript syntax errors, typos, missing colons, invalid flow operators, unquoted multi-word strings, cycle return edges, and wraps top-level bare cues into a valid scene.
Parameters
| Parameter | Type | Presence | Description |
| :--- | :--- | :--- | :--- |
| code | string | Required | The broken or draft MarkdyScript diagram code to automatically repair. |
4. transpile_to_markdy
Converts existing infrastructure definitions or diagrams into animated MarkdyScript scenes.
Parameters
| Parameter | Type | Presence | Allowed Values | Description |
| :--- | :--- | :--- | :--- | :--- |
| source | string | Required | Raw code / markup | Source code to transpile. |
| format | string | Required | mermaid, docker-compose, k8s, terraform, drawio | Format of the input source. |
| title | string | Optional | "Imported Scene" | Scene title rendered in the output diagram header. |
5. explain_architecture
Parses a MarkdyScript AST to output structural topology summaries, component role counts, and governance health metrics.
Parameters
| Parameter | Type | Presence | Description |
| :--- | :--- | :--- | :--- |
| code | string | Required | The MarkdyScript diagram code to inspect. |
6. generate_markdy_prompt
Generates optimal, hallucination-resistant LLM system prompts and grammar constraints tailored to a specific user goal.
Parameters
| Parameter | Type | Presence | Description |
| :--- | :--- | :--- | :--- |
| userGoal | string | Required | Description of the system or workflow to visualize. |
7. get_architecture_catalog
Returns production-grade golden architecture templates (Microservices, RAG, Kafka Event-Driven, K8s Ingress, GitOps CI/CD, OAuth2, HA Multi-Region, Flowcharts) with full runnable MarkdyScript source code.
Parameters
| Parameter | Type | Presence | Description |
| :--- | :--- | :--- | :--- |
| filterCategory | string | Optional | Filter string by category name (e.g. 'AI', 'Cloud', 'Security'). |
8. get_intellicode_completions
Provides context-aware autocompletions, technology presets, next-line flow predictions, and proactive architectural recommendations based on current diagram context.
Parameters
| Parameter | Type | Presence | Default | Description |
| :--- | :--- | :--- | :--- | :--- |
| code | string | Required | None | The MarkdyScript diagram code. |
| line | number | Optional | End of doc | 0-indexed cursor line. |
| column | number | Optional | End of line | 0-indexed cursor column. |
📦 Provided Resources
AI agents can directly read these canonical context URIs via MCP:
| URI | MIME Type | Description |
| :--- | :--- | :--- |
| markdy://spec/agent-reference | text/markdown | Canonical MarkdyScript specification, node kinds, and cycle-prevention rules. |
| markdy://spec/grammar-rules | text/markdown | Comprehensive grammar rules, typo resolution guide, and cycle-safe routing. |
| markdy://templates/catalog | application/json | Curated JSON catalog of all 8 golden architecture templates. |
| markdy://governance/rules | application/json | Well-Architected governance rules and lint presets. |
💬 Provided Prompts
| Prompt | Arguments | Purpose |
| :--- | :--- | :--- |
| create_architecture_diagram | userGoal (req), theme (opt), layout (opt) | Guided workflow to design an animated Markdy architecture diagram from scratch. |
| debug_markdy_syntax | code (req) | Diagnoses and heals broken MarkdyScript syntax errors, typos, and cycle overlaps. |
| audit_architecture | code (req) | Audits a MarkdyScript diagram against Well-Architected governance and cycle-safety rules. |
| transpile_architecture | source (req), format (req) | Guides migration of legacy diagrams or infra into animated MarkdyScript. |
📖 Canonical References
- Authoritative AI Agent Guide: https://markdy.com/AGENT.md
- Human Documentation: https://markdy.com/docs/
- Interactive Playground: https://markdy.com/playground/
- LLM Index: https://markdy.com/llms.txt
License
MIT © Hoang Yell
