Kroki-MCP
by utain
Kroki-MCP is a command-line tool and MCP integration for converting textual diagrams into images using a Kroki backend. It supports both local and remote Kroki servers, with flexible configuration and multiple output formats.
Last updated: N/A
What is Kroki-MCP?
Kroki-MCP is a tool that converts textual diagrams (like PlantUML or Mermaid) into images using a Kroki server. It can be used as a command-line tool or integrated with the Model Context Protocol (MCP).
How to use Kroki-MCP?
Kroki-MCP can be used via the command line with flags to specify the output format, Kroki server, and operation mode (SSE or STDIO). It can also be run as an MCP server, allowing other applications to request diagram conversions.
Key features of Kroki-MCP
SSE and STDIO modes
Supports PNG, SVG, JPEG, and PDF output formats
Configurable Kroki server backend
MCP integration for tool support
Use cases of Kroki-MCP
Generating diagrams from text descriptions in documentation
Integrating diagram generation into automated workflows
Providing a diagram conversion service within an MCP environment
Creating visual representations of models and data
FAQ from Kroki-MCP
What diagram types are supported?
What diagram types are supported?
Kroki-MCP supports any diagram type supported by the configured Kroki server, such as PlantUML, Mermaid, and others.
Can I use a local Kroki server?
Can I use a local Kroki server?
Yes, you can configure Kroki-MCP to use a local Kroki server by specifying the --kroki-host option.
What is the default output format?
What is the default output format?
The default output format is PNG.
How do I run Kroki-MCP as an MCP server?
How do I run Kroki-MCP as an MCP server?
Use the --mode sse option and configure your MCP configuration file to point to the Kroki-MCP command.
How do I contribute to the project?
How do I contribute to the project?
Please see the CONTRIBUTING.md file for guidelines on how to contribute.