Skip to main content

MCP Server for generating Mermaid diagrams with built-in features

Project description

🎨 MCP-Mermaid

智能Mermaid图表生成工具,支持布局优化、主题系统和高质量输出的MCP服务器。

Python Version License PyPI

✨ 核心特性

  • 🎯 智能布局优化 - 自动分析图表结构,选择最优布局方案
  • 🎨 多主题系统 - 5种专业主题,适配不同使用场景
  • 📸 高质量输出 - 支持多种分辨率,确保图表清晰度
  • ☁️ 自动上传 - 集成ImageBB,生成永久访问链接
  • 🔧 MCP协议 - 完整的Model Context Protocol支持
  • 🌐 跨平台 - 支持Linux、macOS、Windows

🚀 快速开始

安装

pip install mcp-mermaid

基本使用

# 查看版本
mcp-mermaid --version

# 查看可用工具
mcp-mermaid --help-tools

# 启动MCP服务器
mcp-mermaid

MCP客户端集成

MCP-Mermaid可以作为工具被AI助手调用,生成高质量的Mermaid图表:

# 示例:通过MCP协议生成流程图
{
    "content": "graph TD; A-->B; B-->C; C-->D",
    "optimize_layout": True,
    "theme": "professional", 
    "quality": "high",
    "upload_image": True
}

🎨 主题展示

支持5种专业主题:

  • professional - 商务专业风格
  • compact - 紧凑信息密集型
  • minimal - 极简清爽风格
  • dark-pro - 深色专业主题
  • default - 经典默认样式

📋 系统要求

  • Python 3.8+
  • Node.js 16+ (用于图表渲染)
  • 系统emoji字体支持

🔧 高级配置

质量设置

  • low - 快速生成,适合预览
  • medium - 平衡质量与速度
  • high - 最高质量,适合正式文档

布局优化

智能识别图表类型并自动优化:

  • 高密度图表 → TB方向 + 紧凑布局
  • 层次结构 → 分层显示优化
  • 流程图表 → LR方向 + 流程对齐
  • 网络图表 → 力导向布局

🤝 贡献指南

欢迎提交Issue和Pull Request!

  1. Fork项目
  2. 创建功能分支 (git checkout -b feature/amazing-feature)
  3. 提交更改 (git commit -m 'Add amazing feature')
  4. 推送分支 (git push origin feature/amazing-feature)
  5. 开启Pull Request

📄 许可证

本项目采用MIT许可证 - 查看 LICENSE 文件了解详情。

🔗 相关链接

📈 更新日志

查看 CHANGELOG.md 了解版本更新详情。

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_mermaid-0.3.5.tar.gz (950.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_mermaid-0.3.5-py3-none-any.whl (928.3 kB view details)

Uploaded Python 3

File details

Details for the file mcp_mermaid-0.3.5.tar.gz.

File metadata

  • Download URL: mcp_mermaid-0.3.5.tar.gz
  • Upload date:
  • Size: 950.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mcp_mermaid-0.3.5.tar.gz
Algorithm Hash digest
SHA256 042c4a1d65e2b5053450edc6341956a9b94e42a5441a2eb463d46e39d600d17e
MD5 78d7c475a01494e83c9c8f1ff9d714b9
BLAKE2b-256 40eadefcddb1f7eead4321bb231bf7f1db48ca227b05bf874b1a90cf9168dae7

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_mermaid-0.3.5.tar.gz:

Publisher: publish.yml on phoenixwu0229/mcp-mermaid

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mcp_mermaid-0.3.5-py3-none-any.whl.

File metadata

  • Download URL: mcp_mermaid-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 928.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mcp_mermaid-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 15c79cb89ce74941ba3a6925fb20a601bc7fa3fe56781ddb308f472aaf8fbf52
MD5 2f9dc591a233e2cbe611bd03e12c0d03
BLAKE2b-256 5f762e2abc704115a5a530073dba32621448d09be68086fb227a8980d3a75fab

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_mermaid-0.3.5-py3-none-any.whl:

Publisher: publish.yml on phoenixwu0229/mcp-mermaid

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page