使用说明

项目简介

本项目 'mcp-server-office' 是一个基于 Model Context Protocol (MCP) 实现的服务器，旨在为大型语言模型（LLM）客户端提供操作 Microsoft Word (.docx) 文档的能力。通过此服务器，LLM 应用可以读取、创建和编辑 Word 文档，从而实现更丰富的文档处理和内容交互功能。

主要功能点

读取 Docx 文件内容: 能够读取 '.docx' 文件的完整内容，包括文本、表格。图片内容会以 '[Image]' 占位符形式表示。读取内容时会忽略文档的修订记录。
创建 Docx 文件: 支持根据给定的文本内容创建新的 '.docx' 文件。内容可以包含文本段落和表格。
编辑 Docx 文件段落: 允许对指定 '.docx' 文件中的段落进行文本替换和插入操作。编辑操作支持指定段落索引，并返回 Git 风格的差异信息，方便追踪修改。

安装步骤

确保您的 Python 环境满足要求 (Python >= 3.12)。

使用 pip 包管理器安装 'mcp-server-office'：

pip install mcp-server-office

或者，如果您使用 uv 包管理器，可以使用以下命令安装：

uv pip install mcp-server-office

服务器配置

对于 MCP 客户端，您需要配置连接到 'mcp-server-office' 服务器的启动命令。以下是一个 JSON 格式的配置示例，您需要将其添加到您的 MCP 客户端配置中：

{
  "serverName": "office-file-server",
  "command": "mcp-server-office",
  "args": []
}

配置参数说明：

'serverName': 服务器名称，必须设置为 '"office-file-server"'，这与服务器自身声明的名称一致。
'command': 启动服务器的命令，设置为 '"mcp-server-office"'。请确保您的系统环境变量 PATH 中包含 Python 的 Scripts 目录，或者您在可执行 'mcp-server-office' 命令的环境中启动 MCP 客户端。如果您使用 'uv'，可以使用 '"uvx mcp-server-office"' 作为命令。
'args': 启动参数列表，本服务器不需要任何启动参数，因此设置为空数组 '[]' 即可。

基本使用方法

启动 'mcp-server-office' 服务器。在安装成功后，您可以在命令行中直接运行 'mcp-server-office' 命令来启动服务器。如果使用 'uv'，则可以使用 'uvx mcp-server-office' 命令。
在 MCP 客户端中配置并连接到 'mcp-server-office' 服务器。客户端会通过 MCP 协议与服务器进行通信。
使用客户端提供的界面或 API，调用 'mcp-server-office' 服务器提供的工具，例如 'read_docx', 'write_docx', 'edit_docx_paragraph', 'edit_docx_insert' 等，以实现对 '.docx' 文件的各种操作。
具体工具的使用方法和参数定义，请参考仓库的 README.md 文档以及工具的 'inputSchema' 定义。例如，读取文件内容需要提供文件路径 'path' 参数。

注意

所有文件路径必须是绝对路径。
写入和编辑操作会直接修改文件，请谨慎操作，建议在操作前备份重要文档。
表格在文本内容中以 '[Table]' 标签开始，并使用 '|' 分隔单元格，换行符分隔行。
图片在读取时会以 '[Image]' 占位符表示，写入功能目前不直接支持图片操作。

关键词

使用说明

信息