使用说明

项目简介

Excel MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在为大型语言模型 (LLM) 应用提供便捷的 Excel 文件处理能力。通过标准化的 MCP 协议,LLM 客户端可以安全、高效地读取、写入和分析 Excel 文件,从而扩展 LLM 在数据处理和分析方面的应用场景。

主要功能点

  • 读取 Excel 文件
    • 获取 Excel 文件中所有工作表的名称。
    • 读取指定工作表的数据。
    • 读取所有工作表的数据。
  • 写入 Excel 文件
    • 创建新的 Excel 文件。
    • 写入数据到指定工作表,支持覆盖已存在的工作表。
    • 支持一次性写入数据到多个工作表。
  • 分析 Excel 结构
    • 分析 Excel 文件的工作表结构和字段信息。
    • 将 Excel 结构导出到新的 Excel 文件。
  • 缓存管理
    • 自动缓存已读取的 Excel 文件内容,提高访问速度。
    • 定时清理过期缓存,保持缓存有效性。
    • 提供手动清理指定文件缓存的功能。
  • 日志管理
    • 自动记录服务器操作日志,便于问题追踪和审计。
    • 定期清理过期日志,节省存储空间。

安装步骤

  1. 安装 Node.js 和 npm:确保您的系统中已安装 Node.js 和 npm(建议使用 Node.js 18 或更高版本)。
  2. 下载仓库代码:将 GitHub 仓库的代码克隆或下载到本地。
  3. 安装依赖:在仓库根目录下,打开终端并运行 'npm install' 命令安装项目依赖。
  4. 构建项目:运行 'npm run build' 命令构建项目,将 TypeScript 代码编译为 JavaScript。

服务器配置

MCP 客户端需要配置以下 JSON 格式信息以连接到 Excel MCP Server:

{
  "serverName": "excel-mcp-server", // 服务名称,与McpServer构造函数中的name一致
  "command": "npm",            // 启动命令,使用 npm
  "args": ["start"]           // 启动参数,运行 npm start 启动服务
}

基本使用方法

  1. 启动服务器:在仓库根目录下,打开终端并运行 'npm start' 命令启动 Excel MCP Server。服务器将通过标准输入/输出 (stdio) 与 MCP 客户端通信。
  2. 客户端调用工具:LLM 客户端可以使用 MCP 协议发送 JSON-RPC 请求到服务器,调用预定义的工具来操作 Excel 文件。例如:
    • 调用 'readSheetNames' 工具并传入 Excel 文件路径参数,获取工作表名称列表。
    • 调用 'readDataBySheetName' 工具并传入文件路径和工作表名称,读取指定工作表的数据。
    • 调用 'writeDataBySheetName' 或 'writeSheetData' 工具并传入文件路径和数据,写入 Excel 文件。
    • 调用 'analyzeExcelStructure' 工具分析 Excel 文件结构。
    • 调用 'exportExcelStructure' 工具导出 Excel 文件结构。
    • 调用 'clearFileCache' 工具清理指定 Excel 文件的缓存。

请参考仓库 'README.md' 文件中的 API 工具 部分,了解每个工具的详细参数和功能描述。

注意: Excel 文件路径需要使用绝对路径。服务器默认监听标准输入/输出流,无需额外配置端口。

信息

分类

桌面与硬件