README
🚀 ExcelReadMCP
ExcelReadMCP 是一个专门的服务器,用于从支持 Model Context Protocol 的客户端(如 Cursor 和 GitHub Copilot)读取 Excel 文件。它专注于读取和搜索操作,不提供写入或格式设置等操作。
✨ 主要特性
提供了一系列实用工具,用于对 Excel 文件进行不同类型的操作。
📦 安装指南
共通设置
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包(当前稳定版本为 1.18.0)作为 MCP 库,因此在requirements.txt中指定了该版本或更高版本。
Cursor 中的设置
- 打开
mcp_config.json,将<path-to-ExcelReadMCP>替换为实际的绝对路径。 - 将其内容追加到 Cursor 引用的 MCP 配置文件(例如:
%USERPROFILE%\.cursor\mcp.json)中。 - 重启 Cursor,确认
Settings > Features > MCP中显示excel-read-mcp。 - 在 Composer(
Ctrl+I)中输入「C:\path\to\workbook.xlsx的工作表列表」等指令,确认工具可以正常使用。
GitHub Copilot 中的设置
- 打开
mcp_config.json,将<path-to-ExcelReadMCP>替换为实际的绝对路径。 - 在 Windows 系统中,编辑
%APPDATA%\GitHub Copilot\mcp.json,并添加excel-read-tools的配置(如果文件不存在,请创建一个新文件)。 - 重启 VS Code,确认 Copilot Chat 的工具列表中显示
excel-read-tools。 - 在 Copilot Chat 中输入「确认
C:\path\to\workbook.xlsx的内容」等指令,测试工具的响应。
💻 使用示例
提供的工具
| 属性 | 详情 |
|------|------|
| excel_read_info | 返回工作簿的元信息(如工作表数量、工作表名称、文件大小等)。 |
| excel_read_range | 以记录数组的形式返回指定工作表(或第一个工作表)的内容。 |
| excel_read_all_sheets | 读取所有工作表,并返回每个工作表的数据和处理状态。 |
| excel_quick_overview | 返回文件概述和每个工作表的示例行。 |
| excel_search | 在整个工作簿(或指定工作表)中搜索字符串。 |
⚠️ 重要提示
所有工具的
file_path参数都必须指定 绝对路径。传递相对路径会导致错误。
🚀 快速开始
启动服务器
cd <path-to-ExcelReadMCP>
start_mcp_server.bat
如果存在虚拟环境,则使用 .venv 中的 Python;如果不存在,则使用系统的 python。
扫码联系在线客服