JinDaGe - Office-Word-MCP-Server MCP Details

article

README

🚀 办公室 Word MCP 服务器

本服务器是一个基于模型上下文协议（MCP）的工具，可用于创建、读取和操作微软 Word 文档。它为 AI 助手提供了标准化接口，使其能与 Word 文档进行交互，具备丰富的文档编辑功能。

🚀 快速开始

办公室 Word MCP 服务器基于模型上下文协议（MCP），可与微软 Word 文档进行交互。它支持多种文档操作，如添加标题、段落、表格和图片，同时还能对文本和表格进行格式化处理。

✨ 主要特性

文档操作：可创建、读取和修改 Word 文档。
内容添加：支持添加标题、段落、表格和图片。
文本格式化：涵盖加粗、斜体、下划线、颜色和字体大小等设置。
表格格式化：可设置表头行、边框样式和单元格底纹。

📦 安装指南

环境要求

操作系统：Windows、Linux 或 macOS
Python 版本：3.6+

安装步骤

克隆仓库：

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

安装依赖项：
```
pip install python-docx fastmcp
```

启动服务器：

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

💻 使用示例

文档路径设置

配置文档存储路径：
- 修改 config.json 文件，指定 document_storage_path。
```
{
  "document_storage_path": "/path/to/storage"
}
```
上传模板：
- 将 Word 模板文件放入 templates 目录。

基础用法

# 添加标题
add_heading("example.docx", "这是一个标题", level=1)

# 添加段落
add_paragraph("example.docx", "这是一个段落。")

# 添加表格
add_table("example.docx", rows=2, cols=3)

📚 详细文档

API 参考

文档操作

创建新文档：
```
create_document(filename)
```
打开现有文档：
```
open_document(filename)
```

内容添加

添加标题：
```
add_heading(filename, text, level=1)
```

添加段落：

add_paragraph(filename, text, style=None)

文本格式化

设置文本样式：

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

🔧 技术细节

故障排除

常见问题

缺少样式
- 使用 Word 模板以确保所有必要样式可用。
权限问题
- 确保服务器有读写文档的权限。
图片插入失败
- 使用绝对路径并检查图片格式和大小。

调试

启用详细日志：

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

贡献指南

欢迎贡献！请参考以下步骤：

Fork 仓库。
创建功能分支。
提交更改。
推送到远程仓库。
提交 Pull Request。

📄 许可证

本项目使用 MIT License。具体信息见 LICENSE 文件。

致谢

模型上下文协议（MCP）提供协议规范。
python-docx 库用于 Word 文档操作。
FastMCP 为 Python MCP 实现提供了支持。

⚠️ 重要提示

此服务器与系统中的文档文件交互。在任何 MCP 客户端（如 Claude for Desktop）确认请求的操作之前，请始终验证其适当性。

Office-Word-MCP-Server