Skip to main content
Glama
Excel MCP Server

Excel MCP Server

by zhiwei5576

Excel MCP Server

npm ็ฎ€ไฝ“ไธญๆ–‡ | English

Excel file processing server based on Model Context Protocol (MCP), providing functionalities for reading, writing, and analyzing Excel files.

Features

  • ๐Ÿ“– Read Excel Files

    • Get worksheet list

    • Read specific worksheet data

    • Read all worksheets data

  • โœ๏ธ Write Excel Files

    • Create new Excel files

    • Write to specific worksheet

    • Support multiple worksheets

  • ๐Ÿ” Analyze Excel Structure

    • Analyze worksheet structure

    • Export structure to new file

  • ๐Ÿ’พ Cache Management

    • Automatic file content caching

    • Scheduled cache cleanup

    • Manual cache clearing

  • ๐Ÿ“ Log Management

    • Automatic operation logging

    • Periodic log cleanup

Related MCP server: ironcalc-mcp

Installation

Installing via Smithery

To install excel-mcp-server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @zhiwei5576/excel-mcp-server --client claude

Installing Manually

Installing via NPM excel-mcp-server can be automatically installed by adding the following configuration to the MCP servers configuration.

Windows Platform:

{
  "mcpServers": {
    "excel": {
        "command": "cmd",
        "args": ["/c", "npx", "--yes", "@zhiweixu/excel-mcp-server"],
        "env": {
            "LOG_PATH": "[set an accessible absolute path]",
            "CACHE_MAX_AGE": "1",
            "CACHE_CLEANUP_INTERVAL": "4",
            "LOG_RETENTION_DAYS": "7",
            "LOG_CLEANUP_INTERVAL": "24"
        }
    }
}

Other Platforms:

{
  "mcpServers": {
    "excel": {
        "command": "npx",
        "args": ["--yes", "@zhiweixu/excel-mcp-server"],
        "env": {
            "LOG_PATH": "[set an accessible absolute path]",
            "CACHE_MAX_AGE": "1",
            "CACHE_CLEANUP_INTERVAL": "4",
            "LOG_RETENTION_DAYS": "7",
            "LOG_CLEANUP_INTERVAL": "24"
        }
    }
}

Note: LOG_PATH is optional. If not set, logs will be stored in the 'logs' folder under the application root directory.other arguments are optional.

API Tools

Structure Tools

  1. analyzeExcelStructure

    • Function: Get Excel file structure including sheet list and column headers in JSON format

    • Parameters:

      • fileAbsolutePath: Absolute path of the Excel file

      • headerRows: Number of header rows (default: 1)

  2. exportExcelStructure

    • Function: Export Excel file structure (sheets and headers) to a new Excel template file

    • Parameters:

      • sourceFilePath: Source Excel file path

      • targetFilePath: Target Excel file path

      • headerRows: Number of header rows (default: 1)

Read Tools

  1. readSheetNames

    • Function: Get all sheet names from the Excel file

    • Parameters:

      • fileAbsolutePath: Absolute path of the Excel file

  2. readDataBySheetName

    • Function: Get data from a specific sheet in the Excel file

    • Parameters:

      • fileAbsolutePath: Absolute path of the Excel file

      • sheetName: Name of the sheet to read

      • headerRow: Header row number (default: 1)

      • dataStartRow: Data start row number (default: 2)

  3. readSheetData

    • Function: Get data from all sheets in the Excel file

    • Parameters:

      • fileAbsolutePath: Absolute path of the Excel file

      • headerRow: Header row number (default: 1)

      • dataStartRow: Data start row number (default: 2)

Write Tools

  1. writeDataBySheetName

    • Function: Write data to a specific sheet in the Excel file (overwrites if sheet exists)

    • Parameters:

      • fileAbsolutePath: Absolute path of the Excel file

      • sheetName: Name of the sheet to write

      • data: Array of data to write

  2. writeSheetData

    • Function: Create a new Excel file with provided data

    • Parameters:

      • fileAbsolutePath: Absolute path for the new Excel file

      • data: Object containing multiple sheet data

Cache Tools

  1. clearFileCache

    • Function: Clear cached data for the specified Excel file

    • Parameters:

      • fileAbsolutePath: Absolute path of the Excel file to clear from cache

Configuration

Environment Variables

  • LOG_PATH: Log files storage path

    • Optional

    • Default: 'logs' folder under application root directory

  • CACHE_MAX_AGE: Cache expiration time (hours)

    • Optional

    • Default: 1

  • CACHE_CLEANUP_INTERVAL: Cache cleanup interval (hours)

    • Optional

    • Default: 4

  • LOG_RETENTION_DAYS: Log retention days

    • Optional

    • Default: 7

  • LOG_CLEANUP_INTERVAL: Log cleanup interval (hours)

    • Optional

    • Default: 24

Default Configuration

  • Cache Configuration

    • Cache expiration time: 1 hour

    • Cache cleanup interval: 4 hours

  • Log Configuration

    • Log retention days: 7 days

    • Cleanup interval: 24 hours

Dependencies

  • @modelcontextprotocol/sdk: ^1.7.0

  • xlsx: ^0.18.5

  • typescript: ^5.8.2

Development Dependencies

  • @types/node: ^22.13.10

  • nodemon: ^3.1.9

  • ts-node: ^10.9.2

License

This project is licensed under the MIT License. This means you are free to:

  • Use the software for commercial or non-commercial purposes

  • Modify the source code

  • Distribute original or modified code Requirements:

  • Retain the original copyright notice

  • No liability can be claimed against the authors for software use For detailed license information,please see the LICENSE file.

Available Tools

8 tools
analyzeExcelStructureA

Get Excel file structure including sheet list and column headers in JSON format

Inputs: fileAbsolutePath (required), headerRows.

clearFileCacheB

Clear cached data for the specified Excel file

Inputs: fileAbsolutePath (required).

exportExcelStructureA

Export Excel file structure (sheets and headers) to a new Excel template file

Inputs: sourceFilePath (required), targetFilePath (required), headerRows.

readDataBySheetNameC

Get data from a specific sheet in the Excel file

Inputs: fileAbsolutePath (required), sheetName (required), headerRow, dataStartRow.

readSheetDataC

Get data from all sheets in the Excel file

Inputs: fileAbsolutePath (required), headerRow, dataStartRow.

readSheetNamesB

Get all sheet names from the Excel file

Inputs: fileAbsolutePath (required).

writeDataBySheetNameC

Write data to a specific sheet in the Excel file (overwrites if sheet exists)

Inputs: fileAbsolutePath (required), sheetName (required), data (required).

writeSheetDataB

Create a new Excel file with provided data

Inputs: fileAbsolutePath (required), data (required).

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelogโ€ฆ

    TDQS

    B3.4/5.0

    Scored across 8 tools

    Disambiguation5/5

    Each tool has a clearly distinct purpose: structure analysis, cache clearing, template export, reading specific/all sheets or names, and writing to sheets or creating new files. No overlaps or ambiguities.

    Naming Consistency4/5

    Most tools follow a verb_target pattern (e.g., 'analyzeExcelStructure', 'readSheetNames'), but there is minor inconsistency: 'readDataBySheetName' vs 'readSheetData' differ in phrasing, and 'exportExcelStructure' uses 'export' instead of 'read' or 'get'.

    Tool Count5/5

    With 8 tools, the server is well-scoped for Excel file operations. Each tool provides essential functionality without unnecessary bloat or sparseness.

    Completeness4/5

    The server covers key operations: reading data, getting structure, writing data, creating files, and cache management. Minor gaps include lack of append/update operations or sheet deletion, but the core workflow is complete.

    Maintenance

    ActivityInactive
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers