
aigroup-mdtoword-mcp
io.github.jackdark425/aigroup-mdtoword-mcp
本地 Markdown 到 Word 文档转换工具,支持最新 MCP 协议特性、完整的页眉页脚页码功能、增强的表格功能、数据导入和数学公式支持,修复本地相对路径图片嵌入问题
Documentation
AI Group Markdown to Word MCP Server
A comprehensive Model Context Protocol (MCP) server for converting Markdown documents to professional Word documents with advanced formatting, styling, and layout capabilities.
🌟 Features
Core Conversion
- Full Markdown Support: Complete Markdown syntax including headings, paragraphs, lists, tables, code blocks, and blockquotes
- Advanced Styling System: Comprehensive style configuration with themes, templates, and custom styling
- Professional Document Layout: Page setup, margins, orientation, and document structure
Advanced Features
- Mathematical Formulas: LaTeX math formula support with inline and block rendering
- Table Processing: Advanced table styling with 12+ preset styles, CSV/JSON data import
- Image Support: Local and remote image embedding with automatic scaling and formatting
- Header & Footer: Complete header/footer system with page numbers, total pages, and custom content
- Table of Contents: Automatic TOC generation with configurable levels and styling
- Watermarks: Text watermarks with configurable position, rotation, and transparency
MCP Integration
- Multiple Transports: Support for STDIO and Streamable HTTP transports
- Tool-based Interface: Clean MCP tool interface for document conversion
- Resource Templates: Pre-built document templates for various use cases
- Prompt System: Intelligent prompts for user guidance and troubleshooting
🚀 Quick Start
Installation
# Using npx (recommended for one-time use)
npx -y aigroup-mdtoword-mcp
# Or install globally
npm install -g aigroup-mdtoword-mcp
Usage with Claude Desktop
Add to your Claude Desktop configuration (claude_desktop_config.json):
{
"mcpServers": {
"markdown-to-word": {
"command": "npx",
"args": ["-y", "aigroup-mdtoword-mcp"]
}
}
}
Usage with Other MCP Clients
{
"mcpServers": {
"markdown-to-word": {
"command": "uvx",
"args": ["aigroup-mdtoword-mcp"]
}
}
}
🛠️ Available Tools
markdown_to_docx
Convert Markdown content to Word document with full styling support.
Input Schema:
{
markdown?: string; // Markdown content (required if inputPath not provided)
inputPath?: string; // Path to Markdown file
filename: string; // Output filename (without extension)
outputPath?: string; // Custom output directory
styleConfig?: StyleConfig; // Advanced styling configuration
}
Example Usage:
Convert this markdown to a Word document:
# Project Report
## Executive Summary
This is a sample report with **bold text** and *italic text*.
- Feature 1: Complete Markdown support
- Feature 2: Advanced styling system
- Feature 3: Professional document layout
| Column 1 | Column 2 | Column 3 |
|----------|----------|----------|
| Data 1 | Data 2 | Data 3 |
| Data 4 | Data 5 | Data 6 |
Mathematical formula: $E = mc^2$
table_data_to_markdown
Convert structured data (CSV/JSON) to formatted Markdown tables.
Input Schema:
{
data: string; // CSV or JSON data
format: 'csv' | 'json'; // Data format
style?: string; // Table style preset
hasHeader?: boolean; // Whether data includes headers
}
📚 Available Resources
Templates
template://customer-analysis- Business analysis report templatetemplate://academic- Academic paper templatetemplate://business- Professional business reporttemplate://technical- Technical documentationtemplate://minimal- Clean minimal template
Style Guides
style-guide://quick-start- Quick styling referencestyle-guide://advanced- Advanced styling optionsstyle-guide://templates- Template usage guide
Performance Metrics
metrics://conversion-stats- Conversion performance datametrics://memory-usage- Memory usage statistics
🎨 Styling System
Basic Styling
{
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 }
}
}
Advanced Features
- Theme System: Color and font variables for consistent branding
- Header/Footer: Custom headers and footers with page numbers
- Watermarks: Text watermarks for document protection
- Table Styling: 12+ preset table styles with zebra striping
- Mathematical Formulas: Professional math formula rendering
📊 Table Styles
The server includes 12 professionally designed table styles:
- minimal - Clean modern style with thin borders
- professional - Business style with dark headers
- striped - Zebra striping for better readability
- grid - Complete grid borders for structured data
- elegant - Double borders for formal documents
- colorful - Colorful headers for vibrant presentations
- compact - Minimal margins for data-dense tables
- fresh - Green theme for environmental reports
- tech - Blue tech theme for technical documents
- report - Formal report style with double borders
- financial - Right-aligned numbers for financial data
- academic - Academic paper style
🔧 Configuration
Style Configuration
Full style configuration supports:
- Document-level settings (fonts, colors, page setup)
- Paragraph and heading styles
- Table and list formatting
- Image and code block styling
- Header/footer configuration
- Watermark settings
Transport Options
- STDIO: Standard input/output for local execution
- Streamable HTTP: HTTP transport for remote servers
📁 Project Structure
src/
├── index.ts # Main MCP server implementation
├── converter/
│ └── markdown.ts # Markdown to DOCX converter
├── template/
│ └── presetLoader.ts # Template system
├── types/
│ ├── index.ts # Core types
│ ├── style.ts # Style configuration types
│ └── template.ts # Template types
└── utils/
├── tableProcessor.ts # Table processing utilities
├── mathProcessor.ts # Mathematical formula processing
├── imageProcessor.ts # Image handling utilities
├── styleEngine.ts # Style application engine
└── errorHandler.ts # Error handling utilities
🧪 Testing
Run the test suite:
npm test
Available test scenarios:
- Mathematical formula conversion
- Local image embedding
- Page numbering and headers/footers
- Table styling and data import
- Complete document conversion
🚀 Performance
- Fast Conversion: Optimized processing for large documents
- Memory Efficient: Stream-based processing for minimal memory usage
- Production Ready: Robust error handling and logging
- Scalable: Handles documents of any size efficiently
🤝 Contributing
We welcome contributions! Please see our Contributing Guidelines for details.
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests
- Submit a pull request
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
🙏 Acknowledgments
- Built with the Model Context Protocol SDK
- Uses docx for Word document generation
- Inspired by the MCP community and ecosystem
📞 Support
- Issues: GitHub Issues
- Documentation: Full Documentation
- Examples: Example Files
AI Group Markdown to Word MCP Server - Professional document conversion powered by MCP protocol.
aigroup-mdtoword-mcpnpm install aigroup-mdtoword-mcp