Excel Reader Server Hby

🚀 Excel Reader Server

An MCP (Model Context Protocol) server that provides tools to read Excel (xlsx) files.

🚀 Quick Start

The Excel Reader Server is an MCP server designed to read Excel (xlsx) files. It offers multiple tools to access worksheet data and returns results in JSON format.

✨ Features

• Read the contents of all worksheets in a file.
• Read the contents of a specific worksheet by name.
• Read the contents of a specific worksheet by index.
• Return data in JSON format.
• Handle empty cells and data type conversions.

📦 Installation

Python 3.10 or higher is required.

# Install using pip
pip install excel-reader-server

# Install using uv (recommended)
uv pip install excel-reader-server

📚 Documentation

Dependencies

• mcp >= 1.2.1
• openpyxl >= 3.1.5

Usage

The server provides three main tools:

💻 Usage Examples

Basic Usage

# Tool 1: read_excel
{
  "file_path": "path/to/your/excel/file.xlsx"
}

# Tool 2: read_excel_by_sheet_name
{
  "file_path": "path/to/your/excel/file.xlsx",
  "sheet_name": "Sheet1"  # Optional parameter
}

# Tool 3: read_excel_by_sheet_index
{
  "file_path": "path/to/your/excel/file.xlsx",
  "sheet_index": 0  # Optional parameter
}

Response Format

The server returns data in the following JSON format:

{
  "Sheet1": [
    ["Header1", "Header2", "Header3"],
    ["Value1", "Value2", "Value3"],
    ["Value4", "Value5", "Value6"]
  ]
}

• Each worksheet is represented as a key in the top-level object.
• Worksheet data is an array, where each inner array represents a row of data.
• All values are converted to string type.
• Empty cells are represented as empty strings.

Error Handling

The server provides clear error messages to handle common issues:

• File not found
• Invalid worksheet name
• Index out of range
• General Excel file reading error

📄 License

This project is released under the MIT License. For more details, see the LICENSE file.

🤝 Contribution Guidelines

Contributions are welcome! Please feel free to submit a Pull Request.