English Français العربية

UML Forge

Official registry Productivity

Architecture intelligence, security analysis, and living docs. 15 tools, Mermaid output.

Source code Documentation

Install

Add this to your client's MCP configuration (Claude Desktop: claude_desktop_config.json; Cursor: .cursor/mcp.json; VS Code and others use the same "mcpServers" shape).

PYPI package umlforge
Claude Code 
claude mcp add uml-forge -e 'UMLFORGE_API_KEY=<your umlforge_api_key>' -- uvx umlforge==0.4.0
JSON configuration (Claude Desktop, Cursor, VS Code) 
{
    "mcpServers": {
        "uml-forge": {
            "command": "uvx",
            "args": [
                "umlforge==0.4.0"
            ],
            "env": {
                "UMLFORGE_API_KEY": "<your umlforge_api_key>"
            }
        }
    }
}

Environment variables

  • UMLFORGE_API_KEY required secret Your UML Forge API key — get one free at https://umlforge.dev

Documentation

From the project's README on GitHub, refreshed weekly. Links open on GitHub.

Contents
  1. UML Forge MCP Connector
  2. Quick start
  3. Tools included
  4. Long-running generations
  5. Requirements
  6. License

UML Forge MCP Connector

Architecture intelligence, security analysis, and living documentation — inside your coding agent.

UML Forge gives Claude Code, Cursor, Windsurf, and any MCP-compatible coding agent a suite of 15 tools (14 diagram tools plus umlforge_get_result) for producing professional UML diagrams from your codebase, schema, or architecture descriptions.

Quick start

Claude Code:

{
  "mcpServers": {
    "umlforge": {
      "command": "uvx",
      "args": ["umlforge"],
      "env": { "UMLFORGE_API_KEY": "your-api-key" }
    }
  }
}

Cursor / Windsurf — add the same block to your MCP settings.

Get your API key at umlforge.dev.

Tools included

ToolDescription
umlforge_suggestStart here. Describe your goal in plain English — returns the right tool and a ready-to-run call
umlforge_reverse_engineerClass, sequence, and state diagrams from a codebase or GitHub URL
umlforge_api_sequenceSequence diagrams for request flows across services
umlforge_erd_schemaEntity-relationship diagrams from domain descriptions or SQL schemas
umlforge_state_machineState diagrams from entity lifecycles and business rules
umlforge_frontend_componentsComponent hierarchy and interaction diagrams for UI features
umlforge_deploymentInfrastructure and CI/CD pipeline diagrams
umlforge_threat_modelSTRIDE threat model + attack surface diagram
umlforge_event_drivenEvent flow and pub/sub architecture diagrams
umlforge_ai_agentAgent topology and tool-call flow diagrams for LLM pipelines
umlforge_stakeholder_archC4 context diagrams for investors, CTOs, and non-technical stakeholders
umlforge_living_docsUpdate existing diagrams to reflect sprint or PR changes
umlforge_onboardingDay-one knowledge-transfer package for new team members
umlforge_legacy_migrationLegacy structure + modern architecture diagrams and 6-phase migration roadmap from COBOL, Fortran, ABAP, RPG, and other legacy languages
umlforge_get_resultRetrieve a generation that was still running (see Long-running generations)

All diagram tools accept report_mode=True to generate a written analysis report alongside the diagram. Leave report_mode unset to follow your account's saved preference (the dashboard toggle); report_mode=False forces diagrams only.

Long-running generations

A detailed diagram can take a minute or two, and some MCP clients cancel any tool call after about 60 seconds. UML Forge tools therefore wait up to 45 seconds for the result. If a diagram is still generating, the tool replies with a job id and umlforge_get_result retrieves it when it is ready (results are kept for one hour). Clients with longer timeouts can wait longer by setting UMLFORGE_WAIT_SECONDS (5-200) in the env block of your MCP configuration.

Requirements

  • Python 3.11+
  • An API key from umlforge.dev (free tier available)

License

MIT — see LICENSE.

Frequently asked questions

What is UML Forge?

Architecture intelligence, security analysis, and living docs. 15 tools, Mermaid output.

How do I install UML Forge?

It runs on your machine. In Claude Code: claude mcp add uml-forge -e 'UMLFORGE_API_KEY=<your umlforge_api_key>' -- uvx umlforge==0.4.0. For other clients, paste the JSON configuration from this page into their MCP settings.

Does UML Forge need an API key?

Yes. It expects UMLFORGE_API_KEY, which you set in its configuration.

Is UML Forge open source?

Yes. Its code is on GitHub under the MIT license.

Who maintains UML Forge?

It is published by dave1362. AI.tn lists it but does not maintain or endorse it.

From the official MCP Registry. Listing is not an endorsement: review a server's code and permissions before giving it access to your data.