MCP文档服务器

MCP（模型上下文协议）服务器，用于生成带有图表的技术文档。

📢 状态： MCP服务器目前正在进行测试。

Language / 语言： 英语 | 波兰语

______________________________________________________________________

英语

📢 状态： MCP服务器目前正在生产环境中进行测试。

🚀 快速开始

# 1. Start Docker containers
docker compose up -d

# 2. Use MCP client with your own prompt
python3 scripts/mcp_client.py -f examples/prompts/prompt.txt

# 3. Or use in Cursor - open conversation and use MCP tools

📦 通过npx安装

您可以直接通过以下方式安装和运行服务器 npx 在不克隆存储库的情况下：

# Latest version from main branch
npx github:lukaszzychal/mcp-doc-generator

# Specific version (tag)
npx github:lukaszzychal/mcp-doc-generator#v0.1.7

# Specific branch
npx github:lukaszzychal/mcp-doc-generator#feat/test-npx-installation

要求：

Node.js>=14.0.0（适用于npx）
Docker和Docker Compose（由包装器自动管理）
Docker守护进程必须正在运行

无需本地Python、Graphviz、Pandoc或其他工具！ 一切都在Docker容器中运行。

有关详细说明，请参阅 NPX_安装.md.

OpenAI图像生成（可选）

使用AI图像生成工具(generate_image_openai, generate_icon_openai, generate_illustration_openai):

设置环境变量：

   export OPENAI_API_KEY=sk-...

获取API密钥： https://platform.openai.com/api-keys

定价： 每张图片0.04-0.12美元（见 ROADMAP.md 详情）

注： OpenAI工具是可选的。所有其他工具都可以在没有API密钥的情况下工作。如果未配置API密钥，您将收到一条带有安装说明的有用错误消息。

波兰语文本自动翻译

OpenAI图像生成工具自动检测波兰语单词并将其翻译成英语，以便在生成的图像中更好地呈现文本。DALL-E 3对非英语文本的支持有限，特别是对变音符号的支持。

为什么选择PL→需要英语翻译

DALL-E 3 限制：

波兰语文本渲染不佳：DALL-E 3与波兰语字符（ą，ć，ę，ł，ń，ó，ś，ź，ž）斗争，经常产生拼写错误，如：

- “结构” → “结构”或“结构” - “弹性”或“弹性” - “多比·科德”→ “DOBBRY KOD”或“GODE CODE”

不支持Diacritics：波兰语变音符号经常被省略或替换为不正确的字符
英语初级培训DALL-E 3主要针对英语文本进行培训，从而提高了英语的准确性
文本渲染质量：图像中的英文文本明显更准确、更易读

为什么我们不支持直接波兰语：

技术限制：这是DALL-E 3模型的限制，不是我们代码中的错误
质量保证：英文文本确保专业、可读的图表
用户体验：自动翻译无需用户干预即可提供最佳结果
经得起未来考验：如果OpenAI改进了对波兰语的支持，我们可以很容易地调整翻译逻辑

我们的解决方案： 我们没有克服DALL-E 3的局限性，而是在图像生成之前自动将波兰语翻译成英语，确保：

✅ 精确的文本渲染
✅ 专业外观的图表
✅ 无需手动翻译
✅ 无缝的用户体验（您仍然可以使用波兰语提示！）

它是如何工作的（混合方法）：

DALL-E 3生成无文本的图形 -仅视觉元素（形状、图标、颜色）
提取文本标签 根据您的提示自动
PIL/Pillow添加文字覆盖 -精确定位的完美文本渲染
结果：DALL-E 3的精美图形+PIL的完美文字

优点：

✅ 100%准确的文本 -没有拼写错误或错误
✅ 支持所有语言 -带有变音符号的波兰语效果完美
✅ 专业品质 -干净易读的标签
✅ 一致的结果 -每次文本相同

技术细节：

自动检测波兰语单词并进行翻译，以确保快速清晰
从提示中提取文本标签（标题、缩略语、标签）
使用DejaVu Sans字体（支持波兰语字符）
智能定位文本（思维导图的中心标签、分支标签）

例子：

输入提示： "Diagram z tytułem 'DOBRY KOD' pokazujący Struktura SOLID"
增强提示： "Diagram with title 'GOOD CODE' showing Structure SOLID" +英语文本渲染指南

您可以在提示中使用波兰语-系统将自动处理图像中出现的文本的翻译。

使用示例

在游标中（推荐）： 简单地用自然语言描述你想要什么：

Wygeneruj ilustrację mapy myśli "Zasady dobrego kodu" z centralnym węzłem 
"Dobry kod = prosty, elastyczny, odporny" i 5 gałęziami: SOLID, DRY, KISS, GRASP, CUPID.
Zapisz jako output/mindmap.png

光标自动：

确认这是一个插图请求
呼叫 generate_illustration_openai 通过MCP协议
自动将波兰语文本翻译成英语
生成图像

使用mcp_client.py：

# Set API key
export OPENAI_API_KEY=sk-...

# Generate illustration from prompt
python3 scripts/mcp_client.py -p "Wygeneruj ilustrację plakatu z zasadami programowania. Zapisz jako output/poster.png"

# Or from file
python3 scripts/mcp_client.py -f prompt.txt

不需要Python代码！ 只要描述一下你想要什么——MCP服务器会自动处理一切。

📦 稳定版

最新稳定版本： v0.1.7

对于生产使用，我们建议使用标记的版本：

# Clone specific version
git clone --branch v0.1.7 https://github.com/lukaszzychal/mcp-doc-generator.git

# Or checkout tag in existing repo
git checkout v0.1.7

可用版本：

v0.1.7 -将版本更新到0.1.7并添加联系信息
v0.1.6 -修复npx安装（包括Docker文件）
v0.1.5 -基于Docker的自动容器管理
v0.1.4 -提交消息规则和验证挂钩
v0.1.3 -npx安装支持，游标规则
v0.1.2 -CI/CD优化，Docker缓存改进
v0.1.1 -以前的稳定版本
v0.1.0 -首次发布

注：这 main 分支包含最新的开发版本。对于生产，使用标记的版本。

替代方案：分散图像（更小更安全）

对于更小、更安全的映像（大约小300-500MB）：

docker compose -f docker-compose.distroless.yml up -d

看医生_建筑_优化.md 了解详情。

📚 文档

用法\_ GIDE.md -完整的使用指南（本地和带游标）
QUICKSTART.md -5分钟内快速启动
CURSOR_NPX_SETUP.md -游标配置指南（npx和Docker）
NPX_安装.md -通过npx安装
项目_结构.md -项目结构
测试_结果_MCP.md -所有工具的测试结果
**** -Docker容器使用说明

🛠️ 可用工具

generate_c4_diagram -C4架构图（上下文、容器、组件、代码）
生成uml图 -UML图（类、组件、部署、包、活动、用例）
生成序列图 -PlantUML序列图
generate_流程图 -美人鱼流程图
generate_mermaid序列 -美人鱼序列图
generate_gantet -甘特图
生成依赖图 -Graphviz依赖图
generate_cloud_diagram -draw.io云架构图
generate_image_openai -使用DALL-E 3生成AI图像（需要OPENAI_API_KEY）
generate_icon_openai -使用DALL-E 3生成AI图标（需要OPENAI_API_KEY）
发电机_插图\_ openai -使用DALL-E 3生成AI插图（需要OPENAI_API_KEY）
export_to_pdf -Markdown到PDF导出
export_to_docx -Markdown到DOCX导出
create_document_from_template -模板文件（ADR、API规范、C4、微服务）

📁 项目结构

MCPServer/
├── src/              # MCP server source code
├── scripts/          # Helper scripts (mcp_client.py, install.sh, generate_examples.py)
├── tests/            # Tests and test files
├── docs/             # Project documentation
├── examples/         # Usage examples
└── output/           # Output directory (mounted in Docker)

细节：项目_结构.md

💡 使用示例

本地（无光标）

# From file
python3 scripts/mcp_client.py -f examples/prompts/prompt.txt

# From command line
python3 scripts/mcp_client.py -p "Generate C4 context diagram for e-commerce. Save as output/diagram.png"

# From stdin
cat prompt.txt | python3 scripts/mcp_client.py

带光标

有两种安装方法可供选择：

方法1:Docker（推荐用于生产环境）

启动容器： docker compose up -d
配置光标MCP设置：

   {
     "mcpServers": {
       "Documentation": {
         "command": "docker",
         "args": [
           "exec",
           "-i",
           "mcp-documentation-server",
           "sh",
           "-c",
           "cd /app/src && PYTHONPATH=/app/src python server.py"
         ],
         "env": {
           "PYTHONPATH": "/app/src"
         }
       }
     }
   }

重新启动游标
在对话中使用MCP工具，例如：

- “为电子商务系统生成C4上下文图” - “使用用户和订单类创建UML类图”

方法2:npx（推荐-自动Docker管理）

确保Docker已安装并正在运行
配置光标MCP设置：

   {
     "mcpServers": {
       "mcp-doc-generator": {
         "command": "npx",
         "args": [
           "github:lukaszzychal/mcp-doc-generator#v0.1.7"
         ]
       }
     }
   }

重新启动游标
包装器自动管理Docker容器，无需手动设置！
在对话中使用MCP工具

看 CURSOR_NPX_SETUP.md 了解详细的配置说明。

🧪 测试

# Tests for all MCP tools
python3 tests/test_mcp_local.py

# Cursor integration test
./tests/test_mcp_cursor_integration.sh

📖 详细信息

使用指南 -详细说明
快速启动 -安装和配置
测试结果 -所有工具的状态
例子 -每种工具的使用示例

🔧 需求

用于npx安装（推荐）

Node.js >=14.0.0（适用于npx）
码头工人 和 Docker Compose （自动管理）
Docker守护进程 必须正在运行

直接安装Docker

码头工人 和 Docker Compose
人工集装箱管理

可选的

光标（用于IDE集成）

📝 许可证

看许可证

💬 社区与支持

讨论：
问题：
联系人： lukasz.zychal.dev@gmail.com

______________________________________________________________________

波兰语

MCP（模型上下文协议）服务器，用于生成带有图表的技术文档。

📢 状态： MCP服务器目前正在进行测试。

🚀 快速启动

# 1. Uruchom kontenery Docker
docker compose up -d

# 2. Użyj klienta MCP z własnym promptem
python3 scripts/mcp_client.py -f examples/prompts/prompt.txt

# 3. Lub użyj w Cursor - otwórz konwersację i użyj narzędzi MCP

📦 通过npx安装

您可以通过直接安装和运行服务器 npx 不克隆仓库：

# Najnowsza wersja z gałęzi main
npx github:lukaszzychal/mcp-doc-generator

# Konkretna wersja (tag)
npx github:lukaszzychal/mcp-doc-generator#v0.1.7

# Konkretna gałąź
npx github:lukaszzychal/mcp-doc-generator#feat/test-npx-installation

要求：

Node.js >= 14.0.0 （对于 npx）
Docker 和 Docker Compose（由 wrapper 自动管理）
Docker 守护进程必须运行

无需在本地安装 Python、Graphviz、Pandoc 或其他工具！ 一切都在Docker容器中运行。

详细说明： NPX_安装.md.

生成OpenAI映像（可选）

为了使用AI图像生成工具（generate_image_openai, generate_icon_openai, generate_illustration_openai):

设置环境变量：

   export OPENAI_API_KEY=sk-...

下载API密钥： https://platform.openai.com/api-keys

价格表： $0.04-0.12 每张图片（见 ROADMAP.md 详情）

请注意： OpenAI工具是可选的。所有其他工具都没有API密钥。如果未配置 API 密钥，您将收到带有配置说明的有用错误消息。

波兰文本的自动翻译

OpenAI图像生成工具会自动检测并将波兰语单词翻译成英语，以便在生成的图像中更好地呈现文本。DALL-E 3 对非英语语言文本的支持有限，特别是对分号的支持。

为什么需要PL→EN映射

DALL-E 3的限制：

波兰文字渲染不佳DALL-E 3在波兰语字符（a， ç， a， l， ń， ó， ś， ż， ż）中存在问题，经常会产生拼写错误，例如：

- “结构”→“结构”或“结构” - “灵活”或“弹性” - “好代码”或“好代码”

不支持区号波兰区号通常被忽略或替换为不正确的字符
培训主要用英语DALL-E 3主要以英语文本进行训练，为英语提供了更好的准确性
文本渲染质量图像中的英文文本更准确和易读

为什么我们不直接支持波兰语：

技术限制这是DALL-E 3的限制，而不是我们的代码中的错误
质量保证英文文本提供专业，易读的图表
用户体验自动翻译提供最佳结果，无需用户干预
未来如果OpenAI改进了对波兰语的支持，我们可以轻松自定义翻译逻辑

我们的解决方案： 而不是与DALL-E 3的限制作斗争，我们在生成图像之前自动将波兰语翻译成英语，确保：

✅ 精确的文本渲染
✅ 专业的图表
✅ 无需手动翻译
✅ 流畅的用户体验（您仍然可以使用中文提示符！）

它是如何工作的（混合方法）：

DALL-E 3 生成无文本图形 - 只有视觉元素（形状，图标，颜色）
文本标签被隔离 从您的提示自动
PIL/Pillow 添加文本覆盖 - 精确定位的优秀文本渲染
结果美丽的图形与DALL-E 3 +优秀的文字与PIL

优势：

✅ 100%准确的文本 - 无拼写错误
✅ 支持所有语言 - 波兰语与隔音工作得很好
✅ 专业品质 清洁、可读的标签
✅ 一致的结果 每次都是一样的文字

技术细节：

自动检测波兰语单词和翻译提示的清晰度
从提示中提取文本标签（标题，缩写，标签）
使用DejaVu Sans字体（支持波兰字符）
智能定位文本（中央标签，思维导图分支标签）

例如：

输入提示： "Diagram z tytułem 'DOBRY KOD' pokazujący Struktura SOLID"
快速改进： "Diagram with title 'GOOD CODE' showing Structure SOLID" + 英文文本渲染说明

您可以在提示中使用波兰语 - 系统将自动为出现在图像中的文本提供翻译。

使用范例

W 光标（推荐）： 用自然语言描述你想要的东西：

Wygeneruj ilustrację mapy myśli "Zasady dobrego kodu" z centralnym węzłem 
"Dobry kod = prosty, elastyczny, odporny" i 5 gałęziami: SOLID, DRY, KISS, GRASP, CUPID.
Zapisz jako output/mindmap.png

自动光标：

他认识到这是一个插图请求
正在调用 generate_illustration_openai 通过MCP协议
自动将波兰文本翻译为英文
生成图像

使用 mcp_client.py：

# Ustaw klucz API
export OPENAI_API_KEY=sk-...

# Wygeneruj ilustrację z promptu
python3 scripts/mcp_client.py -p "Wygeneruj ilustrację plakatu z zasadami programowania. Zapisz jako output/poster.png"

# Lub z pliku
python3 scripts/mcp_client.py -f prompt.txt

你不需要写Python代码。 只需描述您想要的内容 - MCP服务器将自动处理所有内容。

📦 稳定版本

最新稳定版本： v0.1.7

对于生产用途，我们建议使用标记版本：

# Sklonuj konkretną wersję
git clone --branch v0.1.7 https://github.com/lukaszzychal/mcp-doc-generator.git

# Lub przełącz się na tag w istniejącym repo
git checkout v0.1.7

可用版本：

v0.1.7 - 更新到版本 0.1.7 并添加联系信息
v0.1.6 修复npx安装（包括Docker文件）
v0.1.5 Docker 容器自动管理
v0.1.4 - 提交规则和验证钩
v0.1.3 - 支持npx安装，光标规则
v0.1.2 CI/CD优化，Docker缓存改进
v0.1.1 以前的稳定版本
v0.1.0 - 初始版本

请注意： 分支 main 包含最新开发版本。使用标记版本进行生产。

替代方案：Distroless图像（更小，更安全）

对于更小，更安全的图像（大约300-500MB）：

docker compose -f docker-compose.distroless.yml up -d

查看医生_建筑_优化.md 为了细节。

📚 文档

用法\_ GIDE.md - 完整的用户指南（本地和光标）
QUICKSTART.md 5分钟内快速启动
CURSOR_NPX_SETUP.md - 光标配置指南（npx和Docker）
NPX_安装.md 通过npx安装
项目_结构.md - 项目结构
测试_结果_MCP.md 所有工具的测试结果

🛠️ 可用工具

generate_c4_diagram -C4架构图（上下文、容器、组件、代码）
生成uml图 -UML图（类、组件、部署、包、活动、用例）
生成序列图 PlantUML序列图
generate_流程图 -美人鱼流程图
generate_mermaid序列 Mermaid 序列图
generate_gantet 甘特图
生成依赖图 Graphviz 依赖关系图
generate_cloud_diagram draw.io云架构图
export_to_pdf -Eksport降价做PDF
export_to_docx -Eksport降价做DOCX
create_document_from_template - 模板文档（ADR，API Spec，C4，微服务）

📁 项目结构

MCPServer/
├── src/              # Kod źródłowy serwera MCP
├── scripts/          # Skrypty pomocnicze (mcp_client.py, install.sh)
├── tests/            # Testy i pliki testowe
├── docs/             # Dokumentacja projektu
├── examples/         # Przykłady użycia
└── output/           # Katalog wyjściowy (zmountowany w Docker)

细节：项目_结构.md

💡 使用范例

本地（无光标）

# Z pliku
python3 scripts/mcp_client.py -f examples/prompts/prompt.txt

# Z linii komend
python3 scripts/mcp_client.py -p "Generate C4 context diagram for e-commerce. Save as output/diagram.png"

# Z stdin
cat prompt.txt | python3 scripts/mcp_client.py

Z光标

有两种安装方法：

方法1：Docker（推荐用于生产）

Uruchom账户： docker compose up -d
在 Cursor 中配置 MCP 设置：

   {
     "mcpServers": {
       "Documentation": {
         "command": "docker",
         "args": [
           "exec",
           "-i",
           "mcp-documentation-server",
           "sh",
           "-c",
           "cd /app/src && PYTHONPATH=/app/src python server.py"
         ],
         "env": {
           "PYTHONPATH": "/app/src"
         }
       }
     }
   }

重新启动光标
在对话中使用 MCP 工具，例如：

- “为电子商务系统生成C4上下文图” - 创建一个UML类图，其中包含User和Order类

方法 2: npx （推荐 - 自动 Docker 管理）

确保 Docker 已安装并运行
在 Cursor 中配置 MCP 设置：

   {
     "mcpServers": {
       "mcp-doc-generator": {
         "command": "npx",
         "args": [
           "github:lukaszzychal/mcp-doc-generator#v0.1.7"
         ]
       }
     }
   }

重新启动光标
Wrapper自动管理Docker容器 - 无需手动配置！
在对话中使用 MCP 工具

查看 CURSOR_NPX_SETUP.md 详细的配置说明。

🧪 易怒的

# Testy wszystkich narzędzi MCP
python3 tests/test_mcp_local.py

# Test integracji z Cursor
./tests/test_mcp_cursor_integration.sh

# Podstawowe testy systemu
./scripts/test.sh

📖 了解更多

使用指南 - 详细说明
快速启动 - 安装和配置
测试结果所有工具的状态
例子每个工具的使用示例

🔧 要求

安装npx （推荐）

Node.js >= 14.0.0 （对于 npx）
码头工人 我 Docker Compose （自动管理）
Docker恶魔 必须启动

直接安装 Docker

码头工人 我 Docker Compose
手动管理集装箱

可选

光标（与IDE集成）

📝 许可证

查看许可证

💬 社区和支持

讨论：
申请：
Kontakt： lukasz.zychal.dev@gmail.com

MCP Doc Generator

快速接入

详细介绍

MCP文档服务器

英语

🚀 快速开始

📦 通过npx安装

OpenAI图像生成（可选）

波兰语文本自动翻译

为什么选择PL→需要英语翻译

使用示例

📦 稳定版

替代方案：分散图像（更小更安全）

📚 文档

🛠️ 可用工具

📁 项目结构

💡 使用示例

本地（无光标）

带光标

方法1:Docker（推荐用于生产环境）

方法2:npx（推荐-自动Docker管理）

🧪 测试

📖 详细信息

🔧 需求

用于npx安装（推荐）

直接安装Docker

可选的

📝 许可证

💬 社区与支持

波兰语

🚀 快速启动

📦 通过npx安装

生成OpenAI映像（可选）

波兰文本的自动翻译

为什么需要PL→EN映射

使用范例

📦 稳定版本

替代方案：Distroless图像（更小，更安全）

📚 文档

🛠️ 可用工具

📁 项目结构

💡 使用范例

本地（ 无光标）

Z光标

方法1：Docker（推荐用于生产）

方法 2: npx （推荐 - 自动 Docker 管理）

🧪 易怒的

📖 了解更多

🔧 要求

安装npx （推荐）

直接安装 Docker

可选

📝 许可证

💬 社区和支持

目录标签

接入字段

权限和风险

来源信息

继续浏览同类 MCP

本地（无光标）