Excel MCP Server Lpx

🚀 Excel MCP Server

Excel MCP Server is a tool for processing Excel files, supporting reading and writing data, formulas, and images. It can communicate via standard input/output (stdio) or HTTP-based Server-Sent Events (SSE).

🚀 Quick Start

Excel MCP Server is a versatile tool designed to handle various operations on Excel files. It offers seamless communication through either standard input/output (stdio) or Server-Sent Events (SSE) over HTTP.

✨ Features

• Read Data: Extract cell contents from a specified range.
• Read Formulas: Retrieve cell formulas within a specific range.
• Read Images: [Windows only] Extract image data from a specified range in a worksheet.
• Write Data: Write new data to a specified range in an Excel file.
• Write Formulas: Insert new formulas into a specified range.

📦 Installation

Install via NPM

1. Install dependencies:

npm install @fbeawels/excel-mcp-server

2. Run the server (optional parameters):

npx @fbeawels/excel-mcp-server [--transport stdio|sse] [--host <address>] [--port <port>]

Install via Smithery

1. Add the dependency to package.json:

{
  "dependencies": {
    "@fbeawels/excel-mcp-server": "^1.0.0"
  }
}

2. Run the server (optional parameters):

npx @fbeawels/excel-mcp-server [--transport stdio|sse] [--host <address>] [--port <port>]

💻 Usage Examples

Basic Usage

Read Data

Read data from a specified range in an Excel file.

{
  "action": "readData",
  "params": {
    "file": "<file path>",
    "sheet": "<sheet name>",
    "range": "<cell range>"
  }
}

Read Formulas

Read formulas from a specified range in an Excel file.

{
  "action": "readFormula",
  "params": {
    "file": "<file path>",
    "sheet": "<sheet name>",
    "range": "<cell range>"
  }
}

Read Images

[Windows only] Extract image data from a specified range in an Excel file.

{
  "action": "readImage",
  "params": {
    "file": "<file path>",
    "sheet": "<sheet name>",
    "range": "<cell range>"
  }
}

Write Data

Write new data to a specified range in an Excel file.

{
  "action": "writeData",
  "params": {
    "file": "<file path>",
    "sheet": "<sheet name>",
    "range": "<cell range>",
    "data": "<data to write>"
  }
}

Write Formulas

Write new formulas to a specified range in an Excel file.

{
  "action": "writeFormula",
  "params": {
    "file": "<file path>",
    "sheet": "<sheet name>",
    "range": "<cell range>",
    "formulas": "<formulas to write>"
  }
}

📚 Documentation

Command-line Parameters

The following command-line parameters are supported:

• --transport <type>: Set the transport method, options are stdio or sse.
• --host <address>: Set the host address to bind to for SSE transport, default is all interfaces.
• --port <port>: Set the port number for SSE transport, default is 8000.

Example usage:

npx @fbeawels/excel-mcp-server --transport sse --host 0.0.0.0 --port 8000

Environment Variables

The server behavior can be adjusted via the following environment variables:

• EXCEL_MCP_PAGING_CELLS_LIMIT: Set the maximum number of cells to read at once, default is 4000.
• EXCEL_MCP_TRANSPORT: Set the transport method, options are stdio or sse, default is stdio.
• EXCEL_MCP_HOST: Set the host address to bind to for SSE transport, default is an empty string (all interfaces).
• EXCEL_MCP_PORT: Set the port number for SSE transport, default is 8000.

📄 License

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

🔗 Contribution Guidelines

We welcome issues and contributions! Please refer to the CONTRIBUTING.md file for the specific process.