article
README
🚀 AI Group Markdown 转 Word MCP 服务器
这是一个全面的模型上下文协议(MCP)服务器,用于将 Markdown 文档转换为具有高级格式、样式和布局功能的专业 Word 文档。
🚀 快速开始
安装
# 使用 npx(推荐一次性使用)
npx -y aigroup-mdtoword-mcp
# 或者全局安装
npm install -g aigroup-mdtoword-mcp
在 Claude Desktop 中使用
将以下内容添加到你的 Claude Desktop 配置文件(claude_desktop_config.json)中:
{
"mcpServers": {
"markdown-to-word": {
"command": "npx",
"args": ["-y", "aigroup-mdtoword-mcp"]
}
}
}
在其他 MCP 客户端中使用
{
"mcpServers": {
"markdown-to-word": {
"command": "uvx",
"args": ["aigroup-mdtoword-mcp"]
}
}
}
✨ 主要特性
核心转换功能
- 全面的 Markdown 支持:支持完整的 Markdown 语法,包括标题、段落、列表、表格、代码块和块引用。
- 高级样式系统:提供全面的样式配置,支持主题、模板和自定义样式。
- 专业文档布局:支持页面设置、页边距、页面方向和文档结构设置。
高级特性
- 数学公式:支持 LaTeX 数学公式,可进行内联和块级渲染。
- 表格处理:提供 12 种以上预设样式的高级表格样式,支持 CSV/JSON 数据导入。
- 图像支持:支持嵌入本地和远程图像,并自动进行缩放和格式化。
- 页眉页脚:提供完整的页眉页脚系统,支持页码、总页数和自定义内容。
- 目录:可自动生成目录,支持配置目录级别和样式。
- 水印:支持文本水印,可配置水印位置、旋转角度和透明度。
MCP 集成
- 多种传输方式:支持 STDIO 和可流式传输的 HTTP 传输方式。
- 基于工具的接口:提供简洁的 MCP 工具接口,用于文档转换。
- 资源模板:提供多种用例的预建文档模板。
- 提示系统:智能提示功能,为用户提供指导和故障排除帮助。
📦 安装指南
安装命令
# 使用 npx(推荐一次性使用)
npx -y aigroup-mdtoword-mcp
# 或者全局安装
npm install -g aigroup-mdtoword-mcp
💻 使用示例
markdown_to_docx
将 Markdown 内容转换为支持完整样式的 Word 文档。
输入模式:
{
markdown?: string; // Markdown 内容(如果未提供 inputPath,则为必需项)
inputPath?: string; // Markdown 文件路径
filename: string; // 输出文件名(不包含扩展名)
outputPath?: string; // 自定义输出目录
styleConfig?: StyleConfig; // 高级样式配置
}
使用示例:
将以下 Markdown 转换为 Word 文档:
# 项目报告
## 执行摘要
这是一份包含 **粗体文本** 和 *斜体文本* 的示例报告。
- 特性 1:全面的 Markdown 支持
- 特性 2:高级样式系统
- 特性 3:专业文档布局
| 列 1 | 列 2 | 列 3 |
|----------|----------|----------|
| 数据 1 | 数据 2 | 数据 3 |
| 数据 4 | 数据 5 | 数据 6 |
数学公式:$E = mc^2$
table_data_to_markdown
将结构化数据(CSV/JSON)转换为格式化的 Markdown 表格。
输入模式:
{
data: string; // CSV 或 JSON 数据
format: 'csv' | 'json'; // 数据格式
style?: string; // 表格样式预设
hasHeader?: boolean; // 数据是否包含标题
}
📚 详细文档
可用资源
模板
template://customer-analysis- 商业分析报告模板template://academic- 学术论文模板template://business- 专业商业报告模板template://technical- 技术文档模板template://minimal- 简洁模板
样式指南
style-guide://quick-start- 快速样式参考style-guide://advanced- 高级样式选项style-guide://templates- 模板使用指南
性能指标
metrics://conversion-stats- 转换性能数据metrics://memory-usage- 内存使用统计
样式系统
基本样式
{
document: {
defaultFont: "宋体",
defaultSize: 24,
defaultColor: "000000",
page: {
size: "A4",
orientation: "portrait",
margins: { top: 1440, bottom: 1440, left: 1440, right: 1440 }
}
},
headingStyles: {
h1: { font: "黑体", size: 64, color: "000000", bold: true },
h2: { font: "黑体", size: 32, color: "000000", bold: true }
}
}
高级特性
- 主题系统:支持颜色和字体变量,实现一致的品牌风格。
- 页眉页脚:支持自定义页眉页脚,并显示页码。
- 水印:支持文本水印,用于文档保护。
- 表格样式:提供 12 种以上预设表格样式,支持斑马线效果。
- 数学公式:支持专业的数学公式渲染。
表格样式
服务器包含 12 种专业设计的表格样式:
- minimal - 简洁现代风格,细边框
- professional - 商务风格,深色标题
- striped - 斑马线效果,提高可读性
- grid - 完整网格边框,适用于结构化数据
- elegant - 双边框,适用于正式文档
- colorful - 彩色标题,适用于生动的演示文稿
- compact - 最小页边距,适用于数据密集型表格
- fresh - 绿色主题,适用于环境报告
- tech - 蓝色科技主题,适用于技术文档
- report - 正式报告风格,双边框
- financial - 数字右对齐,适用于财务数据
- academic - 学术论文风格
配置
样式配置
完整的样式配置支持:
- 文档级设置(字体、颜色、页面设置)
- 段落和标题样式
- 表格和列表格式
- 图像和代码块样式
- 页眉页脚配置
- 水印设置
传输选项
- STDIO:标准输入输出,适用于本地执行
- Streamable HTTP:HTTP 传输,适用于远程服务器
项目结构
src/
├── index.ts # 主 MCP 服务器实现
├── converter/
│ └── markdown.ts # Markdown 转 DOCX 转换器
├── template/
│ └── presetLoader.ts # 模板系统
├── types/
│ ├── index.ts # 核心类型
│ ├── style.ts # 样式配置类型
│ └── template.ts # 模板类型
└── utils/
├── tableProcessor.ts # 表格处理工具
├── mathProcessor.ts # 数学公式处理工具
├── imageProcessor.ts # 图像处理工具
├── styleEngine.ts # 样式应用引擎
└── errorHandler.ts # 错误处理工具
测试
运行测试套件:
npm test
可用的测试场景:
- 数学公式转换
- 本地图像嵌入
- 页码和页眉页脚
- 表格样式和数据导入
- 完整文档转换
性能
- 快速转换:针对大文档进行了优化处理。
- 内存高效:基于流的处理方式,内存占用最小。
- 生产就绪:具备强大的错误处理和日志记录功能。
- 可扩展:可高效处理任意大小的文档。
🤝 贡献
我们欢迎贡献!请参阅我们的 贡献指南 了解详细信息。
- 分叉仓库
- 创建功能分支
- 进行更改
- 添加测试
- 提交拉取请求
📄 许可证
本项目采用 MIT 许可证 - 有关详细信息,请参阅 LICENSE 文件。
🙏 致谢
- 基于 Model Context Protocol SDK 构建
- 使用 docx 进行 Word 文档生成
- 受 MCP 社区和生态系统的启发
📞 支持
- 问题反馈:GitHub Issues
- 文档:完整文档
- 示例文件:示例文件
AI Group Markdown 转 Word MCP 服务器 - 由 MCP 协议驱动的专业文档转换工具。
微信扫一扫