MCP Kroki Server

MCP Kroki Server

site icon
2025.04.05 2
JavaScript图表转换开发工具开发效率
MCP Kroki Server 是一个基于 Model Context Protocol (MCP) 的服务,专门用于将 Mermaid 等格式的图表转换为 SVG、PNG、PDF 或 JPEG 格式的图像。它利用 Kroki.io 的 API 来实现图表的转换和下载功能,支持多种图表格式,包括 Mermaid、PlantUML、Graphviz 等。
View on GitHub

Overview

基本能力

产品定位

MCP Kroki Server 是一个图表转换服务,专注于将文本描述的图表(如 Mermaid、PlantUML)转换为图像格式,便于在文档或网页中使用。

核心功能

  • 生成图表 URL:通过 Kroki.io API 生成图表的 URL,支持多种输出格式(SVG、PNG、PDF、JPEG)。
  • 下载图表:将图表下载到本地文件,支持多种格式和可选的缩放参数。
  • 多格式支持:支持 Mermaid、PlantUML、Graphviz 等多种图表格式。

适用场景

  • 开发者在文档中嵌入动态生成的图表。
  • 需要将文本描述的图表转换为图像格式的场景。
  • 自动化生成图表并集成到工作流中。

工具列表

  1. Generate Diagram URL:生成图表的 URL,参数包括图表类型、内容和输出格式。
  2. Download Diagram:下载图表到本地文件,参数包括图表类型、内容、输出路径和格式。

常见问题解答

  • 如何安装? 通过 git clonenpm install 安装。
  • 如何使用? 通过 callTool 方法调用生成 URL 或下载图表的功能。
  • 支持哪些图表格式? 支持 Mermaid、PlantUML、Graphviz 等多种格式。

使用教程

使用依赖

  • 需要安装 Node.js 和 npm。

安装教程

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

调试方式

安装完成后,可以通过以下命令启动服务:

node /path/to/mcp-kroki/build/index.js

或者使用 npx:

npx -y @tkoba1974/mcp-kroki

示例代码

// 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'
});

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。