Excel读取工具

ExcelReadMCP 是一个专为 Model Context Protocol 客户端(如 Cursor 和 GitHub Copilot)设计的 Excel 文件读取服务器,专注于读取和搜索功能,不提供写入或格式化操作。

  • by OgumaruSuisan
  • Python
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 OgumaruSuisan/ExcelReadMCP

使用说明

ExcelReadMCP(可翻译为)“Excel读取MCP(或特定配置/模块/程序等,具体含义需根据上下文确定)”

ExcelReadMCP是一个专用服务器,用于从支持模型上下文协议(Model Context Protocol)的客户端(如Cursor和GitHub Copilot)读取Excel文件。它专门用于读取和搜索,不提供写入或格式化操作。

提供工具

工具名称 说明
excel_read_info 返回工作簿的元数据(工作表数量、工作表名称、文件大小等)。
excel_read_range 将指定记录(或首记录)的内容作为记录数组返回。
excel_read_all_sheets 读取所有工作表,并返回每个工作表的数据和处理状态。
excel_quick_overview 返回文件概要和各个工作表的示例行。
excel_search 在工作簿整体(或指定工作表)中搜索字符串。

重要: 在所有工具中 file_path (用于句尾,表示)对于、在……方面 绝对路径 请指定。如果传递相对路径,将会出错。

通用设置

cd <path-to-ExcelReadMCP>
python -m venv .venv
.venv\Scripts\activate
pip install -r requirements.txt

执行示例: 文件夹 C:\Projects\ExcelReadMCP 若展开为cd C:\Projects\ExcelReadMCP → python -m venv .venv → .\.venv\Scripts\Activate.ps1 → pip install -r requirements.txt 然后按顺序在 PowerShell 中执行。

补充: 作为官方的MCP库 mcp 因为使用了软件包(当前稳定版为1.18.0)requirements.txt 也就是说,指定的是该版本以上的版本。

在Cursor中的设置

  1. mcp_config.json 打开<path-to-ExcelReadMCP> 将其替换为实际的绝对路径。
  2. Cursor引用的MCP设置文件(例如: %USERPROFILE%\.cursor\mcp.json)后追加。
  3. 重启 Cursor,进入 Settings > Features > MCP excel-read-mcp 确认会显示“”。
  4. Composer(Ctrl + I)中“C:\path\to\workbook.xlsx 指示“获取工作表列表”等,以确认工具可用。

在GitHub Copilot上的设置

  1. mcp_config.json 打开<path-to-ExcelReadMCP> 将其替换为实际的绝对路径。
  2. 如果是Windows系统的话 %APPDATA%\GitHub Copilot\mcp.json 进行编辑excel-read-tools 请补充相关设置(若文件不存在,请新建)。
  3. 重启 VS Code,然后在 Copilot Chat 的工具列表中 excel-read-tools 确认显示。
  4. 在Copilot Chat中输入“C:\path\to\workbook.xlsx 并指示“确认该内容”等,以测试工具的响应。

服务器启动

cd <path-to-ExcelReadMCP>
start_mcp_server.bat

如果存在虚拟环境 .venv 如果Python不存在,则为系统的 python 会被使用。