Office Word MCP Server

🚀 Office Word MCP Server

An MCP (Model Context Protocol) server for creating, reading, and manipulating Microsoft Word documents. This server enables AI assistants to interact with Word documents through a standardized interface, offering rich document editing capabilities.

🚀 Quick Start

This server is based on the Model Context Protocol (MCP) and is used to interact with Microsoft Word documents. It supports document operations such as adding headings, paragraphs, tables, and images, as well as text and table formatting.

✨ Features

• Document Operations: Create, read, and modify Word documents.
• Content Addition: Support adding headings, paragraphs, tables, and images.
• Text Formatting: Including bold, italic, underline, color, and font size.
• Table Formatting: Support setting table header rows, border styles, and cell shading.

📦 Installation

Environment Requirements

• Operating System: Windows, Linux, or macOS
• Python Version: 3.6+

Installation Steps

1. Clone the repository:

   git clone https://github.com/your-repository.git
   cd your-repository
   

2. Install dependencies:

   pip install python-docx fastmcp
   

3. Start the server:

   export MCP_SERVER=office-word-mcp-server  # Linux/macOS
   set MCP_SERVER=office-word-mcp-server     # Windows
   python server.py
   

💻 Usage Examples

Document Path Configuration

1. Configure the document storage path:
   • Modify the config.json file and specify document_storage_path.

   {
     "document_storage_path": "/path/to/storage"
   }
   

2. Upload templates:
   • Place Word template files in the templates directory.

Basic Usage

Add a Heading

add_heading("example.docx", "This is a heading", level=1)

Add a Paragraph

add_paragraph("example.docx", "This is a paragraph.")

Add a Table

add_table("example.docx", rows=2, cols=3)

📚 Documentation

Document Operations

• Create a New Document:

  create_document(filename)
  

• Open an Existing Document:

  open_document(filename)
  

Content Addition

• Add a Heading:

  add_heading(filename, text, level=1)
  

• Add a Paragraph:

  add_paragraph(filename, text, style=None)
  

Text Formatting

• Set Text Style:

  format_text(filename, paragraph_index, start_pos, end_pos, bold=None,
              italic=None, underline=None, color=None, font_size=None, font_name=None)
  

🔧 Troubleshooting

Common Issues

1. Missing Styles
   • Use Word templates to ensure all necessary styles are available.
2. Permission Issues
   • Ensure the server has read and write permissions for documents.
3. Image Insertion Failure
   • Use absolute paths and check the image format and size.

Debugging

Enable detailed logging:

export MCP_DEBUG=1  # Linux/macOS
set MCP_DEBUG=1     # Windows

🤝 Contribution Guidelines

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Push to the remote repository.
5. Submit a Pull Request.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

🙏 Acknowledgments

• The Model Context Protocol (MCP) provides the protocol specification.
• The python-docx library is used for Word document operations.
• FastMCP provides support for the Python MCP implementation.

⚠️ Important Note

This server interacts with document files in the system. Always verify the appropriateness of operations requested by any MCP client (e.g., Claude for Desktop) before confirming them.