excel-mcp-server

excel-mcp-server

Enables AI assistants to perform Excel file operations such as reading, writing, formatting, and chart creation through the Model Context Protocol.

Category
Visit Server

README

Excel MCP Server

License: MIT Python 3.8+ MCP

A comprehensive Model Context Protocol (MCP) server that provides Excel file manipulation capabilities. This project includes both a standalone Excel library and an MCP server that exposes Excel operations as tools for AI assistants like Claude.

โœจ Features

๐Ÿ“Š Excel Operations

  • Read Excel Files: Extract data from .xlsx and .xls files with range and sheet selection
  • Write Excel Files: Create new Excel files with structured data and headers
  • Worksheet Management: Add, remove, and manage multiple worksheets
  • Cell Operations: Update individual cells and ranges with values or formulas
  • Formula Support: Apply and calculate Excel formulas including cross-sheet references
  • Formatting: Apply styling, fonts, colors, and advanced formatting options
  • Charts: Create various chart types (line, bar, pie, scatter) with customization

๐Ÿ”ง MCP Integration

  • FastMCP Server: High-performance MCP server implementation using the official MCP SDK
  • Resource Endpoints: Built-in help documentation and usage examples
  • Tool Definitions: All Excel operations exposed as MCP tools with full type hints
  • Error Handling: Comprehensive error reporting and logging throughout

๐Ÿš€ Quick Start

Prerequisites

  • Python 3.8 or higher
  • pip package manager

Installation

  1. Clone the repository:

    git clone https://github.com/amanarneja/XSpreadsheet.git
    cd XSpreadsheet
    
  2. Create a virtual environment:

    python -m venv venv
    
  3. Activate the virtual environment:

    # Windows
    venv\Scripts\activate
    
    # macOS/Linux
    source venv/bin/activate
    
  4. Install dependencies:

    pip install -r requirements.txt
    

Usage

Running the MCP Server

cd src/excel_mcp_server
python server.py

The server will start and listen for MCP protocol messages on standard input/output.

Using the Excel Library

from src.excel_mcp_server.excel_library import ExcelLibrary

# Initialize the library
excel_lib = ExcelLibrary()

# Read an Excel file
data = excel_lib.read_excel_file("example.xlsx", "Sheet1")

# Write data to Excel
excel_lib.write_excel_file("output.xlsx", [
    ["Name", "Age", "City"],
    ["John", 30, "New York"],
    ["Jane", 25, "Boston"]
], headers=["Name", "Age", "City"])

Available MCP Tools

Core Operations

  • read_excel_file

    • Read data from Excel files
    • Parameters: file_path, sheet_name (optional), range (optional)
  • write_excel_file

    • Write data to Excel files
    • Parameters: file_path, data, sheet_name (optional), headers (optional)
  • get_worksheet_info

    • Get information about worksheets
    • Parameters: file_path

Worksheet Management

  • add_worksheet
    • Add new worksheets
    • Parameters: file_path, sheet_name

Cell Operations

  • update_cell

    • Update specific cells
    • Parameters: file_path, sheet_name, cell, value
  • apply_formula

    • Apply Excel formulas
    • Parameters: file_path, sheet_name, cell, formula

Formatting and Charts

  • format_cells

    • Apply cell formatting
    • Parameters: file_path, sheet_name, range, format_options
  • create_chart

    • Create charts and graphs
    • Parameters: file_path, sheet_name, data_range, chart_type, title (optional), position (optional)

MCP Resources

  • excel://help - Comprehensive help documentation
  • excel://examples - Usage examples and code snippets

Configuration

VS Code Integration

The project includes VS Code configuration for MCP debugging:

{
  "servers": {
    "excel-mcp-server": {
      "type": "stdio",
      "command": "python",
      "args": ["src/excel_mcp_server/server.py"]
    }
  }
}

Claude Desktop Integration

To use with Claude Desktop, add this to your claude_desktop_config.json:

{
  "mcpServers": {
    "excel-mcp-server": {
      "command": "python",
      "args": ["path/to/XSpreadsheet/src/excel_mcp_server/server.py"],
      "cwd": "path/to/XSpreadsheet"
    }
  }
}

Windows example:

{
  "mcpServers": {
    "excel-mcp-server": {
      "command": "python",
      "args": ["C:\\projects\\XSpreadsheet\\src\\excel_mcp_server\\server.py"],
      "cwd": "C:\\projects\\XSpreadsheet"
    }
  }
}

Alternative: Module Execution

{
  "mcpServers": {
    "excel-mcp-server": {
      "command": "python",
      "args": ["-m", "src.excel_mcp_server.server"],
      "cwd": "path/to/XSpreadsheet"
    }
  }
}

Project Structure

Xpreadsheet/
โ”œโ”€โ”€ src/
โ”‚   โ””โ”€โ”€ excel_mcp_server/
โ”‚       โ”œโ”€โ”€ __init__.py
โ”‚       โ”œโ”€โ”€ server.py           # MCP Server implementation
โ”‚       โ””โ”€โ”€ excel_library.py    # Core Excel functionality
โ”œโ”€โ”€ .vscode/
โ”‚   โ””โ”€โ”€ mcp.json               # VS Code MCP configuration
โ”œโ”€โ”€ .github/
โ”‚   โ””โ”€โ”€ copilot-instructions.md # Copilot development guidelines
โ”œโ”€โ”€ requirements.txt           # Python dependencies
โ””โ”€โ”€ README.md                 # This file

Dependencies

  • mcp: Model Context Protocol SDK
  • openpyxl: Excel file manipulation
  • pandas: Data processing and analysis
  • anyio: Async I/O support

Development

Adding New Features

  1. Excel Library: Add new methods to excel_library.py
  2. MCP Tools: Expose new methods as MCP tools in server.py
  3. Documentation: Update help resources and README

๐Ÿงช Testing & Demo

Run the Demo

python demo.py

This creates sample Excel files demonstrating all features.

Verify Installation

python verify.py

Test Individual Components

# Test the Excel library
python -c "from src.excel_mcp_server.excel_library import ExcelLibrary; print('โœ… Library works!')"

# Test the MCP server (press Ctrl+C to stop)
python src/excel_mcp_server/server.py

๐Ÿ“– Usage Examples

Reading Excel Data with Claude

Once configured, you can ask Claude:

"Read the data from my sales.xlsx file, sheet called 'Q1 Data', range A1:D10"

Claude will use the read_excel_file tool:

{
  "file_path": "sales.xlsx",
  "sheet_name": "Q1 Data", 
  "range": "A1:D10"
}

Creating Charts with Claude

"Create a line chart from my data.xlsx file showing the sales trend. Use data from A1:B12 on the 'Sales' sheet"

Claude will use the create_chart tool:

{
  "file_path": "data.xlsx",
  "sheet_name": "Sales",
  "data_range": "A1:B12",
  "chart_type": "line",
  "title": "Sales Trend"
}

Writing Excel Files

"Create a new Excel file called 'report.xlsx' with this data: [['Name', 'Score'], ['Alice', 95], ['Bob', 87]]"

Claude will use the write_excel_file tool:

{
  "file_path": "report.xlsx",
  "data": [["Alice", 95], ["Bob", 87]],
  "headers": ["Name", "Score"]
}

๐Ÿค Contributing

We welcome contributions! Here's how to get started:

  1. Fork the repository on GitHub
  2. Clone your fork locally:
    git clone https://github.com/amanarneja/XSpreadsheet.git
    
  3. Create a feature branch:
    git checkout -b feature/amazing-feature
    
  4. Make your changes and add tests
  5. Run the verification:
    python verify.py
    python demo.py
    
  6. Commit your changes:
    git commit -m "Add amazing feature"
    
  7. Push to your branch:
    git push origin feature/amazing-feature
    
  8. Open a Pull Request on GitHub

Development Guidelines

  • Follow the existing code style and patterns
  • Add type hints to all functions
  • Include docstrings for new methods
  • Update tests and documentation
  • Ensure all demo scripts still work

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

๐Ÿ†˜ Support & Resources

๐ŸŒŸ Acknowledgments


๐Ÿš€ Ready to supercharge your Excel workflows with AI? Get started today!

GitHub stars GitHub forks

Recommended Servers

playwright-mcp

playwright-mcp

A Model Context Protocol server that enables LLMs to interact with web pages through structured accessibility snapshots without requiring vision models or screenshots.

Official
Featured
TypeScript
Magic Component Platform (MCP)

Magic Component Platform (MCP)

An AI-powered tool that generates modern UI components from natural language descriptions, integrating with popular IDEs to streamline UI development workflow.

Official
Featured
Local
TypeScript
Audiense Insights MCP Server

Audiense Insights MCP Server

Enables interaction with Audiense Insights accounts via the Model Context Protocol, facilitating the extraction and analysis of marketing insights and audience data including demographics, behavior, and influencer engagement.

Official
Featured
Local
TypeScript
VeyraX MCP

VeyraX MCP

Single MCP tool to connect all your favorite tools: Gmail, Calendar and 40 more.

Official
Featured
Local
graphlit-mcp-server

graphlit-mcp-server

The Model Context Protocol (MCP) Server enables integration between MCP clients and the Graphlit service. Ingest anything from Slack to Gmail to podcast feeds, in addition to web crawling, into a Graphlit project - and then retrieve relevant contents from the MCP client.

Official
Featured
TypeScript
Kagi MCP Server

Kagi MCP Server

An MCP server that integrates Kagi search capabilities with Claude AI, enabling Claude to perform real-time web searches when answering questions that require up-to-date information.

Official
Featured
Python
E2B

E2B

Using MCP to run code via e2b.

Official
Featured
Neon Database

Neon Database

MCP server for interacting with Neon Management API and databases

Official
Featured
Exa Search

Exa Search

A Model Context Protocol (MCP) server lets AI assistants like Claude use the Exa AI Search API for web searches. This setup allows AI models to get real-time web information in a safe and controlled way.

Official
Featured
Qdrant Server

Qdrant Server

This repository is an example of how to create a MCP server for Qdrant, a vector search engine.

Official
Featured