使用说明
项目简介
mcp-excel-server 是一个基于 Spring AI MCP 框架开发的应用后端,旨在通过 MCP 协议,赋予大语言模型(LLM)操作本地 Excel 文件的能力。它允许 LLM 像调用本地工具一样,动态地读取和写入 Excel 数据,从而拓展 LLM 在数据处理和办公自动化方面的应用场景。
主要功能点
- 读取 Excel 文件:支持 '.xlsx' 和 '.xls' 格式的 Excel 文件,将文件内容解析为 JSON 格式返回给 LLM。
- 写入 Excel 文件:接收 JSON 格式的数据,将其写入到指定的本地 Excel 文件中。
- MCP 协议支持:遵循 MCP 协议标准,可以与任何兼容 MCP 协议的 LLM 客户端(如 Claude、Cursor、Cherry Studio 等)无缝集成。
安装步骤
- 安装 Java 环境:确保您的计算机上已安装 Java 17 或更高版本。
- 下载代码:从 GitHub 仓库 https://github.com/bigcoder84/mcp-excel-server 下载项目代码。
- 打包:打开命令行终端,进入项目根目录,执行以下 Maven 命令进行打包:
打包成功后,将在 'target' 目录下生成 'mcp-excel-server-0.0.1-SNAPSHOT.jar' 文件。mvn clean package -Dmaven.test.skip=true
服务器配置
MCP 服务器需要配置在 MCP 客户端中,以便客户端能够连接和调用该服务器提供的功能。以下是 mcp-excel-server 的 JSON 格式配置信息,请添加到您的 MCP 客户端配置文件中:
{ "mcpServers": { "excel-server": { // 服务器名称,您可以自定义 "name": "Excel操作", // 服务器显示名称,用于在客户端界面展示 "type": "stdio", // 连接类型,mcp-excel-server 使用 stdio 标准输入输出流进行通信 "description": "提供 Excel 文件读取和写入功能", // 服务器描述,用于在客户端界面展示 "isActive": true, // 是否启用该服务器,设置为 true 表示启用 "command": "java", // 启动服务器的命令,这里使用 java 命令 "args": [ // 启动命令的参数列表 "-Dspring.ai.mcp.server.stdio=true", // 启用 Spring AI MCP 的 stdio 支持 "-Dspring.main.web-application-type=none", // 禁用 Spring Boot 的 Web 应用特性,因为本服务不需要 Web 界面 "-Dfile.encoding=UTF-8", // 设置文件编码为 UTF-8,避免中文乱码问题 "-jar", // 指定以 jar 包方式运行 "{your_path}/mcp-excel-server-0.0.1-SNAPSHOT.jar" // 指定 jar 包的绝对路径,请替换为实际的 jar 包路径 ] } } }
注意:请将 '{your_path}/mcp-excel-server-0.0.1-SNAPSHOT.jar' 替换为实际的 'mcp-excel-server-0.0.1-SNAPSHOT.jar' 文件在您电脑上的绝对路径。
基本使用方法
-
启动 MCP 客户端:确保您使用的 LLM 客户端已正确配置并启动了 MCP 功能。
-
配置 MCP 服务器:将上述 JSON 配置信息添加到 MCP 客户端的配置文件中,并确保配置正确。
-
在 LLM 中调用工具:在 LLM 的交互界面中,您可以指示 LLM 使用 "Excel操作" 服务器提供的工具来读取或写入 Excel 文件。
-
读取 Excel 文件:告诉 LLM 读取指定路径的 Excel 文件,例如:'读取 /path/to/your/excel/file.xlsx 文件中的内容'。LLM 客户端会将该请求转换为 MCP 调用,并调用 mcp-excel-server 的 'readExcel' 工具,并将文件路径作为参数传递给服务器。服务器执行读取操作后,会将 Excel 数据以 JSON 格式返回给 LLM。
-
写入 Excel 文件:告诉 LLM 将指定 JSON 数据写入到 Excel 文件,例如:'将以下 JSON 数据写入到 /path/to/your/output/file.xlsx 文件:[{"列1": "值1", "列2": "值2"}, {"列1": "值3", "列2": "值4"}],表头为 ["列1", "列2"]'。LLM 客户端会将请求转换为 MCP 调用,并调用 mcp-excel-server 的 'writeToExcel' 工具,并将文件路径、表头和数据列表作为参数传递给服务器。服务器执行写入操作后,会返回操作结果。
-
请注意:
- 文件路径必须是服务器能够访问的本地绝对路径。
- LLM 客户端需要根据 MCP 协议正确构造请求,才能调用 mcp-excel-server 提供的工具。
- mcp-excel-server 仅提供 Excel 文件的读写功能,具体的业务逻辑和数据处理需要在 LLM 应用中实现。
信息
分类
桌面与硬件