MCP Kroki

🚀 MCP Kroki Server

An MCP (Model Context Protocol) server for converting Mermaid diagrams into SVG images, utilizing Kroki.io.

🚀 Quick Start

The MCP Kroki Server is designed to convert various diagram formats into different image formats. It uses the Kroki.io API to achieve this functionality.

✨ Features

• Generate diagram URLs using Kroki.io.
• Download diagrams as SVG, PNG, PDF, or JPEG files.
• Support multiple diagram formats:
  • Mermaid
  • PlantUML
  • Graphviz
  • And more (refer to the Kroki.io documentation).

📦 Installation

Local Installation

git clone https://github.com/tkoba1974/mcp-kroki.git
cd mcp-kroki
npm install
npm run build

💻 Usage Examples

Basic Usage

The server provides two main tools:

1. Generate Diagram URL

Generate a URL for a diagram using Kroki.io.

Parameters:

• type: Diagram type (e.g., "mermaid", "plantuml").
• content: Diagram content in the specified format.
• outputFormat (optional): Output format (svg, png, pdf, jpeg, base64).

2. Download Diagram

Download a diagram to a local file.

Parameters:

• type: Diagram type (e.g., "mermaid", "plantuml").
• content: Diagram content in the specified format.
• outputPath: Path to save the diagram.
• outputFormat (optional): Output format (svg, png, pdf, jpeg).
• scale (optional, number, default value is 1.0): Scale factor for the diagram size. Currently only affects SVG output, attempting to modify the width/height attributes. The minimum value is 0.1.

Code Examples

// Generate a URL for a Mermaid diagram
const result = await callTool('generate_diagram_url', {
  type: 'mermaid',
  content: 'graph TD; A-->B; B-->C; C-->D;',
  outputFormat: 'svg'
});

// Download a Mermaid diagram
const result = await callTool('download_diagram', {
  type: 'mermaid',
  content: 'graph TD; A-->B; B-->C; C-->D;',
  outputPath: '/path/to/diagram.svg'
});

🔧 Technical Details

The server uses the Kroki.io API for diagram conversion. Before sending to Kroki.io, the diagram content is compressed and encoded.

📚 Documentation

Using with Claude Desktop

Add the following configuration to your Claude Desktop configuration file (claude_desktop_config.json):

Local Installation:

{
  "mcpServers": {
    "mcp-kroki": {
      "command": "node",
      "args": ["/path/to/mcp-kroki/build/index.js"]
    }
  }
}

Using npx:

{
  "mcpServers": {
    "mcp-kroki": {
      "command": "npx",
      "args": [
        "-y",
        "@tkoba1974/mcp-kroki"
      ]
    }
  }
}

📄 License

MIT