mcp-kroki

🚀 MCP Kroki 服务器

MCP Kroki 服务器是一个基于 MCP（模型上下文协议）的工具，借助 Kroki.io 服务，可轻松将 Mermaid 等多种图表转换为 SVG 等格式的图像。它为开发者提供了便捷的图表生成与下载功能，能有效提升工作效率。

🚀 快速开始

MCP Kroki 服务器可帮助你将多种格式的图表转换为不同类型的图像文件。下面为你介绍它的安装与使用方法。

✨ 主要特性

• URL 生成：利用 Kroki.io 生成图表的 URL。
• 多格式下载：支持将图表下载为 SVG、PNG、PDF 或 JPEG 文件。
• 多格式支持：涵盖 Mermaid、PlantUML、Graphviz 等多种图表格式（更多格式请参阅 Kroki.io 文档）。

📦 安装指南

本地安装

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

💻 使用示例

基础用法

服务器提供了两个主要工具，以下是它们的使用示例：

// 生成 Mermaid 图表的 URL
const result = await callTool('generate_diagram_url', {
  type: 'mermaid',
  content: 'graph TD; A-->B; B-->C; C-->D;',
  outputFormat: 'svg'
});

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

高级用法

在下载图表时，你可以使用 scale 参数调整图表尺寸：

// 下载 Mermaid 图表并调整尺寸
const result = await callTool('download_diagram', {
  type: 'mermaid',
  content: 'graph TD; A-->B; B-->C; C-->D;',
  outputPath: '/path/to/diagram.svg',
  outputFormat: 'svg',
  scale: 1.5
});

📚 详细文档

生成图表 URL

使用 Kroki.io 生成图表的 URL，需要传入以下参数：

• type：图表类型（例如，“mermaid”，“plantuml”）
• content：指定格式的图表内容
• outputFormat（可选）：输出格式（svg, png, pdf, jpeg, base64）

下载图表

将图表下载到本地文件，需要传入以下参数：

• type：图表类型（例如，“mermaid”，“plantuml”）
• content：指定格式的图表内容
• outputPath：保存图表的位置路径
• outputFormat（可选）：输出格式（svg, png, pdf, jpeg）
• scale（可选，数字，默认值为 1.0）：图表尺寸的比例因子。当前仅影响 SVG 输出，尝试修改 width/height 属性。最小值为 0.1。

🔧 技术细节

服务器使用 Kroki.io API 进行图表转换。在发送到 Kroki.io 之前，图表内容会被压缩并编码，以提高传输效率和处理速度。

📚 详细文档

使用 Claude Desktop

你可以将以下配置添加到您的 Claude Desktop 配置文件（claude_desktop_config.json）中：

本地安装：

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

使用 npx：

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

📄 许可证

本项目采用 MIT 许可证。