uml-mcp

uml-mcp

12

UML-MCP is a server designed for generating UML and other types of diagrams efficiently by implementing the Model Context Protocol (MCP). It supports multiple output formats and is easily integrated with AI assistants and other applications. The server provides resources and tools for creating various diagram types using different rendering engines.

UML-MCP: A Diagram Generation Server with MCP Interface

UML-MCP is a powerful diagram generation server that implements the Model Context Protocol (MCP), enabling seamless diagram creation directly from AI assistants and other applications.

🌟 Features

  • Multiple Diagram Types: Support for UML diagrams (Class, Sequence, Activity, etc.), Mermaid, D2, and more
  • MCP Integration: Seamless integration with LLM assistants supporting the Model Context Protocol
  • Playground Links: Direct links to online editors for each diagram type
  • Multiple Output Formats: SVG, PNG, PDF, and other format options
  • Easy Configuration: Works with local and remote diagram rendering services

📋 Supported Diagram Types

UML-MCP supports a wide variety of diagram types including Class, Sequence, Activity, Use Case, State, Component, Deployment, and Object diagrams. It also supports Mermaid, D2, Graphviz, ERD, BlockDiag, BPMN, and C4 with PlantUML.

🚀 Getting Started

Prerequisites

  • Python 3.10 or higher
  • pip (Python package installer)

Installation

  1. Clone the repository: git clone https://github.com/yourusername/uml-mcp.git
  2. Install the dependencies: pip install -r requirements.txt
  3. For development environments: pip install -r requirements-dev.txt

Running the Server

Start the MCP server using python mcp_server.py. This will start the server using stdio for communication with MCP clients.

📚 Documentation

For detailed documentation, visit the directory or the documentation site.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is licensed under the MIT License - see the file for details.

👏 Acknowledgements

  • PlantUML - UML diagram generation
  • Kroki - Unified diagram generation service
  • Mermaid - Generation of diagrams from text
  • D2 - Modern diagram scripting language