ExcelReadMCP Server

Provides read-only access to Excel workbook data via MCP tools for efficient querying and inspection.

python

2

GitHub Stars

python

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "ogumarusuisan-excelreadmcp": {
      "command": "start_mcp_server.bat",
      "args": [],
      "env": {
        "PYTHONUNBUFFERED": "1"
      }
    }
  }
}

ExcelReadMCP is a dedicated server that reads Excel files for Model Context Protocol clients like Cursor and GitHub Copilot. It focuses on reading and searching data, not writing or formatting, making it ideal for extracting and querying workbook content quickly.

How to use

You run the ExcelReadMCP server and connect your MCP client to it. Use the provided tools to inspect workbook metadata, read ranges or all sheets, get quick overviews, and search for text across sheets. Always pass absolute file paths to avoid errors. Once the server is running, invoke the available tools from your MCP client by specifying the target workbook and, when needed, the sheet or range you want to inspect.

Key tools you can use are: excel_read_info to retrieve workbook metadata, excel_read_range to fetch a specific sheet as records, excel_read_all_sheets to load every sheet with per-sheet data, excel_quick_overview to get a file outline plus sample rows, and excel_search to find strings in the workbook or a specific sheet.

How to install

Prerequisites: Python 3.x installed on your system.

Common setup steps you will follow in your environment:

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

Additional notes

Server startup is done from the project path using the start script. The virtual environment is used if present; otherwise the system Python is used.

cd <path-to-ExcelReadMCP>
start_mcp_server.bat

Available tools

excel_read_info

Returns workbook metadata such as sheet count, sheet names, and file size.

excel_read_range

Returns the contents of a specified sheet (or the first sheet) as a records array.

excel_read_all_sheets

Reads all sheets and returns data per sheet along with processing status.

excel_quick_overview

Provides a file overview and sample rows from each sheet.

excel_search

Searches for a string across the workbook or a specified sheet.