doc-tools-mcp 仓库详细介绍
项目概述
doc-tools-mcp 仓库提供了一个基于模型上下文协议(MCP)的服务器,旨在通过人工智能驱动来实现对Word文档的操作。该服务器实现了MCP协议,使得AI应用可以通过自然语言互动来创建、编辑和管理Word文档,提升文档处理的智能化水平。
功能概览
doc-tools-mcp 服务器所实现的功能是全面的,其主要特色包括:
- 完整的MCP协议实现:支持MCP协议的所有必要步骤,确保与各类MCP兼容应用之间的交流顺畅。
- Word文档创建与管理:可轻松创建新的Word文档,并对现有文档进行各种管理操作。
- 富文本内容操作:支持对文本、段落、格式化等进行智能化的编辑。
- 表格创建与格式化:能够按需创建表格,并进行相关布局和样式设置。
- 文档布局控制:对文档的整体布局如页边距、排列等进行操控。
- 文档元数据管理:获取与设置文档的元数据,便于组织与检索。
- 实时文档状态监测:随时监控文档状态,提供动态反馈与修改能力。
安装步骤
前置条件
在安装 doc-tools-mcp 服务器之前,需要确保系统满足以下条件:
- 具备 Node.js 14 或更高版本
- (可选)安装 Microsoft Word,以支持高级文档功能
安装方法
您可以使用以下命令通过 npx 来启动 doc-tools-mcp 服务器:
npx @puchunjie/doc-tools-mcp
或将其全局安装:
npm install -g @puchunjie/doc-tools-mcp
如果在项目中用作依赖,则可使用:
npm install @puchunjie/doc-tools-mcp
使用指南
启动MCP服务器:
npx @puchunjie/doc-tools-mcp
缺省情况下服务器将在端口8765启动。您可以通过配置AI应用(例如Cursor、VSCode)的方式使用服务器:
http://localhost:8765
MCP功能
以下是doc-tools-mcp服务器提供的主要功能:
-
create_document
- 创建新的Word文档- 参数:filePath(必需), title, author
-
open_document
- 打开已有Word文档- 参数:filePath(必需)
-
add_paragraph
- 添加段落到文档- 参数:filePath(必需), text(必需), style, alignment
-
add_table
- 添加表格到文档- 参数:filePath(必需), rows(必需), cols(必需), headers, data
-
search_and_replace
- 查找并替换文档中的文本- 参数:filePath(必需), searchText(必需), replaceText(必需), matchCase
-
set_page_margins
- 设置文档页边距- 参数:filePath(必需), top, right, bottom, left
-
get_document_info
- 获取文档元数据- 参数:filePath(必需)
与AI应用集成
Cursor集成
为了能让Cursor编辑器使用doc-tools-mcp,请进行如下配置:
打开Cursor的配置文件
~/.cursor/mcp.json
,添加如下配置:{
"mcpServers": {
"doc-tools-mcp": {
"command": "npx",
"args": [
"@puchunjie/doc-tools-mcp"
]
}
}
}
对于本地开发版本的配置:
{
"mcpServers": {
"doc-tools-mcp": {
"command": "node",
"args": [
"/path/to/your/doc-tools-mcp/dist/mcp-server.js"
]
}
}
}
配置完成后,您即可通过自然语言来操控Word文档:
"创建一个名为report.docx的新文档"
"在report.docx中添加标题'月度报告'"
"插入一个包含销售数据的4x3表格"
VSCode及其他MCP兼容工具
类似的集成步骤也可应用于其他支持MCP协议的工具。请参考工具的文档以了解特定的MCP服务器配置步骤。
开发指南
如果您有意愿扩展或修改这一MCP服务器,请按照以下步骤进行:
- 克隆仓库:
git clone <repository-url>
cd doc-tools-mcp
- 安装依赖:
npm install
- 启动开发模式:
npm run start
- 构建生产版本:
npm run build
增加新的MCP功能
- 在
中添加新方法src/services/DocumentService.ts
- 在
src/mcp-server.ts
中注册新功能 - 根据需要更新类型定义
配置说明
- 默认端口:8765(可配置)
- 支持的文件类型:.docx
- 所有文件路径应为绝对路径或相对工作目录的路径
授权协议
doc-tools-mcp 采用MIT许可证发布,用户可以自由使用、修改和分发。
技术支持
如果您在使用过程中遇到任何问题或有改进建议,欢迎在我们的GitHub仓库提交issue。
应用场景及价值
随着文档处理需求的不断增加,doc-tools-mcp 提供了一种高效、智能化的解决方案。可广泛应用于企业文档管理、报告生成、动态文档更新及个人办公自动化工具的开发。通过将自然语言处理与传统文档管理相结合,极大地提升了生产力和用户体验,为用户提供了一个现代化的操作平台。