Ilograph
Runs the Ilograph MCP server within a containerized environment, allowing easy deployment and isolation.
Accesses repository features for CI workflows, issue tracking, and discussions for the Ilograph MCP server project.
Validates Ilograph diagrams written in YAML syntax, providing detailed error messages and suggestions for correction.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Ilograph validate this diagram syntax for me"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
🎯 Ilograph MCP Server
The Ilograph MCP Server is a Model Context Protocol (MCP) server that provides AI agents with comprehensive access to Ilograph documentation, validation tools, and diagram creation guidance. Transform complex architecture documentation with intelligent assistance.
Use Cases
Automated Diagram Creation: Generate Ilograph diagrams through natural language descriptions
Real-time Validation: Validate existing diagrams with detailed error analysis and suggestions
Documentation Access: Get instant access to comprehensive Ilograph documentation and best practices
Learning & Examples: Explore curated diagram examples with detailed explanations
Important: This is an unofficial, community-driven project and is not affiliated with or endorsed by Ilograph LLC. The server provides educational and development assistance by accessing publicly available Ilograph documentation and resources.
Caution: The outputs and recommendations provided by the MCP server are generated dynamically and may vary based on the query and model. Users should thoroughly review all outputs to ensure they align with their project requirements and verify against official Ilograph documentation before implementation.
Related MCP server: Fast Mermaid Validator MCP
Prerequisites
Docker: Docker installed and running
MCP-compatible client: Claude Desktop, VS Code, Cursor, etc.
Quick Start
Add to Your MCP Client
Add this configuration to your MCP client:
VS Code:
Add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing Ctrl + Shift + P and typing Preferences: Open User Settings (JSON).
More about using MCP server tools in VS Code's agent mode documentation.
{
"mcp": {
"servers": {
"ilograph": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"ghcr.io/quincymillerdev/ilograph-mcp-server:latest"
]
}
}
}
}Optionally, you can add a similar example (i.e. without the mcp key) to a file called .vscode/mcp.json in your workspace. This will allow you to share the configuration with others.
{
"servers": {
"ilograph": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"ghcr.io/quincymillerdev/ilograph-mcp-server:latest"
]
}
}
}Claude Desktop / Cursor / Jetbrains AI Assistant:
{
"mcpServers": {
"ilograph": {
"command": "docker",
"args": ["run", "-i", "--rm", "ghcr.io/quincymillerdev/ilograph-mcp-server:latest"]
}
}
}That's it! 🎉
Tool Configuration
Available Tools
The following tools are available for comprehensive Ilograph workflow support:
Category | Tool | Description |
Documentation |
| Fetches comprehensive documentation from Ilograph's official sources with intelligent caching |
Documentation |
| Lists all available documentation sections with descriptions and coverage areas |
Documentation |
| Performs health checks and returns cache statistics for documentation service |
Specification |
| Fetches the official Ilograph specification with complete property definitions and types |
Specification |
| Performs health checks specifically on the specification service connectivity |
Examples |
| Lists available Ilograph example diagrams categorized by complexity and use case |
Examples |
| Retrieves specific example diagrams with metadata, learning context, and explanations |
Validation |
| Validates Ilograph diagram syntax and provides detailed error messages with suggestions |
Validation |
| Provides comprehensive guidance on diagram validation and common issues resolution |
Icons |
| Searches the live Ilograph icon catalog with semantic matching and provider filtering |
Icons |
| Lists all available icon providers (AWS, Azure, GCP, etc.) and their service categories |
Contributing
Contributions are welcome! This project needs:
🐛 Bug fixes - Always appreciated!
📚 Documentation improvements - Help make things clearer
✨ New tools - Add more Ilograph functionality
🔧 Code quality - Better error handling, etc.
📖 See CONTRIBUTING.md for detailed development setup, testing, and submission guidelines.
Features
📚 Live Documentation Access: Fetches up-to-date documentation from official Ilograph sources
🔍 Comprehensive Section Coverage: Access to all major Ilograph concepts (resources, perspectives, contexts, etc.)
✅ Advanced Diagram Validation: YAML and Ilograph schema validation with detailed error messages and suggestions
⚡ Intelligent Caching: TTL-based caching with fallback strategies for optimal performance
🛠️ Tool-First Design: Compatible with all current MCP clients (Cursor, Claude Desktop, VS Code, etc.)
📋 Curated Example Library: Real-world Ilograph diagrams with learning context and explanations
🎨 Smart Icon Search: Semantic search through Ilograph's icon catalog with provider filtering
🔄 Health Monitoring: Built-in service health checks and status reporting
🏗️ Architecture Pattern Detection: Identifies common patterns and provides optimization suggestions
Need Help?
Tool Usage: See the available tools in the table above
Issues: GitHub Issues
Questions: GitHub Discussions
License
This project is licensed under the MIT License - see the LICENSE file for details.
Legal Disclaimer
This project is not affiliated with, endorsed by, or connected to Ilograph LLC. This is an independent, community-driven tool that accesses publicly available Ilograph documentation and resources for educational and development purposes.
The Ilograph name and related trademarks are property of Ilograph LLC
This tool accesses publicly available documentation under fair use principles
Users should refer to official Ilograph documentation for authoritative information
No commercial relationship exists between this project and Ilograph LLC
Links
Built with ❤️ for the Ilograph community
Available Tools
11 toolscheck_documentation_healthARead-only
Checks the health and connectivity of the documentation fetching service.
This tool performs connectivity tests and returns status information about
the documentation fetching capabilities, including cache statistics.
Returns:
str: Health status report with service connectivity and cache information
Inputs: no named parameters.
check_spec_healthARead-only
Checks the health and connectivity of the specification fetching service.
This tool performs connectivity tests specifically for the specification endpoint
and returns status information about spec fetching capabilities.
Returns:
str: Health status report with spec service connectivity and cache information
Inputs: no named parameters.
fetch_documentation_toolARead-only
Fetches and formats narrative documentation from Ilograph website.
This tool provides detailed explanations, tutorials, and examples for learning
Ilograph concepts and implementation patterns. Content is fetched from the official
Ilograph documentation site and converted to clean markdown format.
Args:
section: Documentation section to fetch. Supported sections:
- 'resources' -> Resource tree organization, hierarchies, instanceOf patterns
- 'relation-perspectives' -> Arrow connections, from/to properties, routing, labels
- 'sequence-perspectives' -> Time-based diagrams with steps, bidirectional flows
- 'references' -> Resource reference patterns and advanced referencing
- 'advanced-references' -> Complex reference scenarios and usage patterns
- 'resource-sizes-and-positions' -> Layout control, resource sizing, visual hierarchy
- 'parent-overrides' -> Resource parent overrides in perspectives with scale properties
- 'perspectives-other-properties' -> Additional perspective properties and options
- 'icons' -> Icon system with iconStyle, icon paths, and categorization
- 'walkthroughs' -> Interactive step-by-step guides through diagrams
- 'contexts' -> Multiple context views with roots, extends inheritance
- 'imports' -> Namespace management with from/namespace properties, component reuse
- 'markdown' -> Rich text support in descriptions, notes, and diagram text
- 'tutorial' -> Complete tutorial for learning Ilograph diagram creation
Returns:
str: Clean markdown content with detailed explanations, examples, and best practices
Inputs: section (required).
fetch_exampleBRead-only
Retrieves a static example diagram with its content and learning context.
Args:
example_name: The filename of the example to fetch (e.g., 'serverless-on-aws.ilograph').
Returns:
A dictionary containing the example's content, metadata, learning objectives, and patterns.
Inputs: example_name (required).
fetch_spec_toolARead-only
Fetches the official Ilograph specification from https://www.ilograph.com/docs/spec/
This tool provides the authoritative reference for all Ilograph properties, types,
and requirements in a structured table format - perfect for validation and quick lookups.
Returns:
str: Complete specification in markdown format with:
- Top-level properties table
- Resource properties and types
- Perspective properties and types
- Relation, Sequence, Step definitions
- Context, Layout, Import specifications
- All property types and requirements
Inputs: no named parameters.
get_validation_helpARead-only
Provides comprehensive help for Ilograph diagram validation.
Returns guidance on common validation issues, proper syntax,
and best practices for creating valid Ilograph diagrams.
Returns:
str: Detailed validation help in markdown format
Inputs: no named parameters.
list_documentation_sectionsARead-only
Lists all available Ilograph documentation sections with descriptions.
This tool provides an overview of all available documentation sections
that can be fetched using the fetch_documentation_tool.
Returns:
str: Formatted list of available documentation sections with descriptions
Inputs: no named parameters.
list_examplesARead-only
Lists available Ilograph example diagrams, optionally filtering by category.
Args:
category: Filter examples by complexity ('beginner', 'intermediate', 'advanced').
Returns:
A dictionary containing a list of available examples and a message guiding the user.
Inputs: category.
list_icon_providers_toolARead-only
Lists all available icon providers and their categories.
This tool provides an overview of the icon catalog structure,
showing available providers and their service categories.
Returns:
dict: Provider information with categories and icon counts
Inputs: no named parameters.
search_icons_toolARead-only
Searches the current icon catalog with semantic matching.
This tool fetches the live icon catalog from Ilograph and provides intelligent
search capabilities to help find appropriate icons for diagram resources.
Args:
query: Search term (e.g., 'database', 'aws lambda', 'kubernetes', 'storage')
provider: Optional filter by provider ('AWS', 'Azure', 'GCP', 'Networking')
Returns:
list: Matching icons with paths, categories, and usage information.
Each icon dict contains:
- path: The icon path for use in Ilograph diagrams
- provider: The cloud provider or category (AWS, Azure, GCP, Networking)
- category: The service category (e.g., 'Compute', 'Database', 'Analytics')
- name: The specific icon name
- usage: Example usage string for Ilograph diagrams
Inputs: query (required), provider.
validate_diagram_toolARead-only
Validates Ilograph YAML syntax and structure.
This tool performs comprehensive validation of Ilograph diagrams:
1. First validates YAML syntax for structural correctness
2. Then validates Ilograph-specific schema requirements
3. Provides detailed error messages, warnings, and suggestions
4. Can optionally use official Ilograph specification for context
Args:
content: The Ilograph diagram content as a string
Returns:
dict: Validation result with success/failure, errors, warnings, and suggestions
Format: {
"success": bool,
"yaml_valid": bool,
"schema_valid": bool,
"summary": {"total_errors": int, "total_warnings": int, "total_info": int},
"errors": [{"level": str, "message": str, "line": int, "suggestion": str}, ...],
"warnings": [...],
"info": [...],
"assessment": str
}
Inputs: content (required).
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 11 tools
Each tool serves a distinct purpose: health checks for different services, fetching different types of content (documentation, examples, spec), listing available resources, searching icons, and validating diagrams. No two tools have overlapping functionality.
Tool names are mostly snake_case but inconsistently use the 'tool' suffix (e.g., fetch_documentation_tool vs fetch_example) and mix verbs like 'check_', 'list_', 'search_', and 'get_'. This lacks a uniform pattern.
With 11 tools covering health checks, documentation fetching, example retrieval, spec fetching, icon searching, and validation, the count is well-scoped for a diagramming assistant server without being excessive.
The tool surface covers information retrieval (docs, specs, examples, icons) and validation, which aligns with the server's purpose. A minor gap is the lack of a diagram generation tool, but this is not essential for a helper server.
Maintenance
Related MCP Connectors
Provides access to Google's public developer documentation.
Render, verify, describe, and safely edit Mermaid diagrams through MCP.
Manage SysML2 projects; check, evaluate, verify, query, document and diagram models.
Create, validate, edit, export (markdown/svg/png/mermaid), and search JSON Canvas files.
Related MCP Servers
- AlicenseBqualityDmaintenanceA Model Context Protocol server that validates and renders Mermaid diagrams.157MIT
- AlicenseNot gradedqualityDmaintenanceValidates Mermaid diagrams with comprehensive grammar parsing supporting 28+ diagram types. Processes markdown files, ZIP archives, and direct input with detailed error reporting and enterprise-grade performance capabilities.50 npm3Apache 2.0
- AlicenseNot gradedqualityDmaintenanceProvides MCP tools to validate Mermaid diagram syntax, render diagrams to SVG, and get documentation links.16MIT
- AlicenseNot gradedqualityBmaintenanceProvides a real API for coding agents to look up design system components, props, and tokens, preventing guessed answers.9MIT