Skip to main content

FastMCP server providing AI agents with Ilograph diagram creation and validation capabilities

Project description

🎯 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.

CI Python FastMCP License: MIT

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.

Prerequisites

  1. Docker: Docker installed and running
  2. 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 fetch_documentation_tool Fetches comprehensive documentation from Ilograph's official sources with intelligent caching
Documentation list_documentation_sections Lists all available documentation sections with descriptions and coverage areas
Documentation check_documentation_health Performs health checks and returns cache statistics for documentation service
Specification fetch_spec_tool Fetches the official Ilograph specification with complete property definitions and types
Specification check_spec_health Performs health checks specifically on the specification service connectivity
Examples list_examples Lists available Ilograph example diagrams categorized by complexity and use case
Examples fetch_example Retrieves specific example diagrams with metadata, learning context, and explanations
Validation validate_diagram_tool Validates Ilograph diagram syntax and provides detailed error messages with suggestions
Validation get_validation_help Provides comprehensive guidance on diagram validation and common issues resolution
Icons search_icons_tool Searches the live Ilograph icon catalog with semantic matching and provider filtering
Icons list_icon_providers_tool 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?

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iflow_mcp_ilograph_mcp_server-0.1.0.tar.gz (70.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iflow_mcp_ilograph_mcp_server-0.1.0-py3-none-any.whl (67.4 kB view details)

Uploaded Python 3

File details

Details for the file iflow_mcp_ilograph_mcp_server-0.1.0.tar.gz.

File metadata

File hashes

Hashes for iflow_mcp_ilograph_mcp_server-0.1.0.tar.gz
Algorithm Hash digest
SHA256 492eb004ef9b304e6d50c75a1c4dbc216feaa889cea1228607ca39ee89af386c
MD5 bc1f69669a6c1bc75568143d4ecbded5
BLAKE2b-256 76dc652969021bb668f14557eaede4fc45e7812cb7dc6bf200851d6b8451a253

See more details on using hashes here.

File details

Details for the file iflow_mcp_ilograph_mcp_server-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for iflow_mcp_ilograph_mcp_server-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 26b9fce1f46330ac58996f709300196cb4c0bde3899110ee0bbcaedc4783175e
MD5 3fdb0bb8afdfbab7b4af871dd1a5f473
BLAKE2b-256 f8b552ecf80249cbeab174fb9f0dfa7c3efde3f5080adfbe1815033013347bbc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page