README
🚀 办公室 MCP 服务器
Office MCP Server 是一个基于 Java 的非官方 模型上下文协议 (MCP) 服务器,主要用于管理和处理来自 AI 代理对 Word、Excel 等文件的请求,为办公文件处理提供了高效的解决方案。
🚀 快速开始
下载项目
克隆或下载 Office MCP Server 项目的源代码。
构建项目
使用 Maven 或 Gradle 等工具构建项目,生成可执行的 JAR 文件。
运行服务器
- 打开终端,导航到项目目录。
- 运行以下命令启动服务器:
java -jar target/office-mcp-server-0.0.1-SNAPSHOT-runner.jar
访问 API
打开浏览器或使用工具(如 Postman)访问服务器提供的 API 端点。默认情况下,服务器运行在 http://localhost:8080。有关更多详细信息,请参考 文档。
✨ 主要特性
- 基于 Java 构建,使用 Quarkus 框架,具备快速启动时间和低内存使用率,适合云原生应用。
- 支持多种 MCP 工具和资源,可对 Excel 文件进行多种操作。
📦 安装指南
通过 Maven 安装
将以下依赖项添加到 pom.xml 文件中:
<dependency>
<groupId>com.example</groupId>
<artifactId>office-mcp-server</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
然后运行 Maven 安装命令:
./mvnw clean install
通过 Gradle 安装
在 build.gradle 文件中添加以下依赖项:
dependencies {
implementation 'com.example:office-mcp-server:0.0.1-SNAPSHOT'
}
然后运行 Gradle 安装命令:
./gradlew clean build
💻 使用示例
基础用法
目前文档未提供基础使用的代码示例,后续可根据实际情况补充。
📚 详细文档
框架
该项目使用 Quarkus 构建,这是一个专为构建轻量级、高性能微服务设计的 Kubernetes 原生 Java 框架。Quarkus 提供了快速启动时间和低内存使用率,非常适合云原生应用。
支持的方法
该服务器支持以下 MCP 工具和资源:
Excel 功能
| 工具 | 参数 | 说明 |
| ---- | ---- | ---- |
| 获取文件名 | filename - Excel 文件的名称 | 检索 Excel 文件的文件名 |
| 创建 Excel 工作簿 | filepath - 创建新 Excel 工作簿的路径 | 创建一个新的 Excel 工作簿 |
| 创建 Excel 工作表 | filepath - Excel 工作簿的路径sheetName - 新工作表的名称 | 在 Excel 工作簿中创建新的工作表 |
| 添加 Excel 行 | filepath - Excel 文件的路径sheetName - 工作表的名称rowData - 新行的数据 | 向 Excel 工作表中添加一行 |
| 读取 Excel 单元格 | filepath - Excel 文件的路径sheetName - 工作表的名称rowNum - 行号(0 基数)colNum - 列号(0 基数) | 从 Excel 工作表中读取单元格内容 |
| 关闭 Excel 工作簿 | filepath - 要关闭的 Excel 文件的路径 | 关闭一个 Excel 工作簿 |
| 获取 Excel 工作表数量 | filepath - Excel 文件的路径 | 获取 Excel 工作簿中的工作表数量 |
| 获取 Excel 行数 | filepath - Excel 文件的路径sheetName - 工作表的名称 | 获取工作表中的行数 |
| 获取 Excel 列数 | filepath - Excel 文件的路径sheetName - 工作表的名称 | 获取工作表中的列数 |
配置
环境变量配置
您可以通过以下环境变量自定义服务器的行为:
| 环境变量 | 说明 | 默认值 |
| ---- | ---- | ---- |
| PORT | 指定服务器的监听端口 | 8080 |
| LOG_LEVEL | 设置日志级别,可选值为 DEBUG、INFO、WARN、ERROR | INFO |
日志文件
默认情况下,日志文件保存在 logs/ 目录下。您可以根据需要修改日志输出路径或格式。
测试
单元测试
使用 Maven 或 Gradle 运行单元测试:
./mvnw test
集成测试
在项目根目录下运行集成测试脚本:
sh tests/run_integration_tests.sh
🔧 技术细节
该项目使用 Quarkus 框架构建,利用其轻量级、高性能的特性,实现了对 MCP 协议的支持,能够高效管理和处理来自 AI 代理的办公文件请求。同时,通过环境变量配置和日志管理,提高了项目的灵活性和可维护性。
📄 许可证
该项目在 MIT 许可证下发布。有关详细信息,请参阅 LICENSE 文件。
支持
该项目按现状提供,不附带任何保证。如果遇到问题或有疑问,请在 GitHub 仓库中打开问题。
微信扫一扫