使用说明

项目简介

Excel Reader Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务器，专注于为大型语言模型 (LLM) 应用提供访问 Excel (.xlsx) 文件数据的能力。它通过 MCP 协议与客户端通信，提供工具让 LLM 可以读取 Excel 文件的内容，并以 JSON 格式返回。

主要功能点

读取整个 Excel 文件: 可以读取 Excel 文件中所有工作表的数据。
按工作表名称读取: 可以指定工作表名称来读取特定工作表的数据。
按工作表索引读取: 可以指定工作表索引（从0开始）来读取特定工作表的数据。
JSON 格式输出: 所有读取的数据都以易于解析的 JSON 格式返回。
错误处理: 提供清晰的错误信息，例如文件未找到、工作表名称无效、索引超出范围等。

安装步骤

环境要求: 确保已安装 Python 3.10 或更高版本。

安装命令: 推荐使用 'uv' 或 'pip' 安装。

# 使用 uv (推荐)
uv pip install excel-reader-server

# 或使用 pip
pip install excel-reader-server

服务器配置

要使 MCP 客户端连接到 Excel Reader Server，需要配置客户端的服务器启动命令和参数。以下是 JSON 格式的配置信息，可以直接用于 MCP 客户端配置：

{
  "serverName": "excel-reader-server",
  "command": "python",
  "args": ["-m", "excel_reader_server"]
}

配置参数说明:

'serverName': 服务器名称，设置为 "excel-reader-server"。
'command': 启动服务器的命令，这里使用 "python" 来运行 Python 解释器。
'args': 传递给 'command' 的参数列表，'["-m", "excel_reader_server"]' 表示以模块方式运行 'excel_reader_server' 包，启动服务器。

基本使用方法

启动服务器: 在安装了 'excel-reader-server' 的环境中，MCP 客户端根据上述配置启动 Excel Reader Server。服务器将通过标准输入/输出 (stdio) 与客户端通信。

调用工具: 客户端可以使用 MCP 协议向服务器发送请求，调用以下工具来读取 Excel 数据。

读取所有工作表 ('read_excel'):

{
  "tool_call": {
    "tool_name": "read_excel",
    "tool_arguments": {
      "file_path": "path/to/your/excel/file.xlsx"  // Excel 文件路径，例如 "data.xlsx"
    }
  }
}

按名称读取工作表 ('read_excel_by_sheet_name'):

{
  "tool_call": {
    "tool_name": "read_excel_by_sheet_name",
    "tool_arguments": {
      "file_path": "path/to/your/excel/file.xlsx", // Excel 文件路径
      "sheet_name": "Sheet1"                     // (可选) 工作表名称，默认为第一个工作表
    }
  }
}

按索引读取工作表 ('read_excel_by_sheet_index'):

{
  "tool_call": {
    "tool_name": "read_excel_by_sheet_index",
    "tool_arguments": {
      "file_path": "path/to/your/excel/file.xlsx", // Excel 文件路径
      "sheet_index": 0                          // (可选) 工作表索引，默认为 0 (第一个工作表)
    }
  }
}

接收响应: 服务器会将读取到的 Excel 数据以 JSON 格式封装在 MCP 响应中返回给客户端。客户端可以解析 JSON 响应，获取 Excel 数据。

注意: 'file_path' 参数应为服务器可以访问到的 Excel 文件路径。根据 MCP 的上下文，这通常是相对于服务器文件系统的路径。

关键词