Skip to main content

基于MCP协议的Markdown转Word转换工具

Project description

md-to-word MCP Server

Markdown 转 Word 文档 MCP 服务器

功能特性

  • ✅ 将 Markdown 文件转换为 Word 文档
  • ✅ 支持自定义 Word 模板
  • ✅ 模板管理功能
  • ✅ Markdown 文件验证
  • ✅ 示例文件创建
  • ✅ 文件信息查看

安装和使用

1. 安装依赖

# 使用 uv
uv add pypandoc-binary mcp

# 或使用 pip
pip install pypandoc-binary mcp

2. 启动服务器

# 直接运行
python -m md_to_word_mcp

# 或使用模块方式
python src/md_to_word_mcp/server.py

3. 配置 Claude Desktop

在 Claude Desktop 的配置文件中添加:

{
  "mcpServers": {
    "md-to-word": {
      "command": "python",
      "args": ["-m", "md_to_word_mcp"],
      "cwd": "/path/to/your/project"
    }
  }
}

可用工具

1. convert_md_to_word

将 Markdown 文件转换为 Word 文档。

参数:

  • input_file: 输入的 Markdown 文件路径
  • output_file: 输出的 Word 文件路径(可选)
  • template: Word 模板文件路径(可选)
  • title: 文档标题(可选)
  • author: 文档作者(可选)

2. create_markdown_sample

创建示例 Markdown 文件。

参数:

  • filename: 输出文件名(默认:sample.md)
  • content_type: 内容类型(product_manual/technical_doc/user_guide/custom)
  • custom_content: 自定义内容(当 content_type 为 custom 时)

3. list_templates

列出可用的 Word 模板。

4. validate_markdown

验证 Markdown 文件格式和内容。

参数:

  • file_path: Markdown 文件路径

使用示例

在 Claude 中使用:

请帮我将 README.md 转换为 Word 文档
创建一个产品手册的示例文件
列出所有可用的模板

文件结构

md转word/
├── src/
│   └── md_to_word_mcp/
│       ├── __init__.py
│       ├── __main__.py
│       ├── server.py          # MCP 服务器
│       ├── converter.py       # 转换器
│       ├── template_manager.py # 模板管理器
│       └── utils.py           # 工具函数
├── pyproject.toml
├── batch_demo.py          # 原始示例脚本
├── product_manual_black.docx  # 默认模板
└── README.md

配置选项

可以通过修改 server.py 中的 config 对象来调整设置:

config = {
    "default_template": "product_manual_black.docx",  # 默认模板
    "output_dir": "./output",                        # 输出目录
    "max_file_size": 50 * 1024 * 1024,              # 最大文件大小 (50MB)
    "supported_formats": [".md", ".markdown", ".txt"] # 支持的格式
}

注意事项

  1. 确保 product_manual_black.docx 模板文件存在于项目根目录
  2. 支持的输入格式:.md、.markdown、.txt
  3. 输出格式:.docx
  4. 模板格式:.docx、.dotx
  5. 最大文件大小限制:50MB

问题排查

如果遇到问题,请检查:

  1. 是否正确安装了 pypandoc-binary
  2. 输入文件是否存在且可读
  3. 模板文件是否存在且是有效的 Word 文档
  4. 输出目录是否有写入权限

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

md_to_word_mcp-0.1.1.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

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

md_to_word_mcp-0.1.1-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file md_to_word_mcp-0.1.1.tar.gz.

File metadata

  • Download URL: md_to_word_mcp-0.1.1.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for md_to_word_mcp-0.1.1.tar.gz
Algorithm Hash digest
SHA256 d02795ee7ce264ca8e6a89fcafc45212a38bb9eb6e8b3d098f3c9a3f79a67a47
MD5 83900430f3aba54755bf9bb2be956bdb
BLAKE2b-256 97b22595e94e35bd073eb15e5041774ae61d188672e1f9278a689ae525a7dee6

See more details on using hashes here.

File details

Details for the file md_to_word_mcp-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: md_to_word_mcp-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for md_to_word_mcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1d0e1a0b114161c93ac43e019939b7a3c5e94eff1dc38580a032750389d87f47
MD5 f62f5d4a03225276a081bd13dec4b75e
BLAKE2b-256 6d2fbd619625705c54e5b5a63ada2c52810f20d18d9061f11dbc1f8c79f90c68

See more details on using hashes here.

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