Excel Reader

🚀 MCP Excel Reader

A server based on the Model Context Protocol (MCP) for reading Excel files with automatic chunking and pagination. Built with SheetJS and TypeScript, this tool helps you efficiently handle large Excel files by automatically breaking them into manageable chunks.

🚀 Quick Start

A server based on the Model Context Protocol (MCP) for reading Excel files with automatic chunking and pagination. Built with SheetJS and TypeScript, this tool helps you efficiently handle large Excel files by automatically breaking them into manageable chunks.

✨ Features

• 📊 Support for reading Excel files (.xlsx, .xls) with automatic size limit setting.
• 🔄 Automatic chunking for large datasets.
• 📑 Support for worksheet selection and row pagination.
• 📅 Correct date handling.
• ⚡ Optimized for large file processing.
• 🛡️ Error handling and validation.

📦 Installation

Install via Smithery

Automatically install the Excel Reader for Claude Desktop through Smithery:

npx -y @smithery/cli install @ArchimedesCrypto/excel-reader-mcp-chunked --client claude

As an MCP Server

1. Install globally:

npm install -g @archimdescrypto/excel-reader

2. Add to your MCP configuration file (usually located at ~/.config/mcp/config.json):

{
  "servers": {
    "excel-reader": {
      "url": "http://localhost:3000"
    }
  }
}

💻 Usage Examples

Interface Definition

Request Parameters

interface ReadExcelArgs {
  file: string; // Excel file path or URL
  sheet?: number | string; // Worksheet number or name to read (optional)
  headers?: boolean; // Whether to include header rows (default is true)
}

Response Format

interface ExcelResponse {
  data: any[]; // Parsed data array
  error?: string; // Error message (returned if there is an error)
}

Basic Usage

import { readExcel } from '@archimdescrypto/excel-reader';

async function main() {
  try {
    const result = await readExcel({
      file: 'path/to/file.xlsx',
      sheet: 0, // Specify the first worksheet
      headers: true // Include header rows
    });
    
    if (result.error) {
      console.error('Error reading file:', result.error);
    } else {
      console.log('Data read successfully:', result.data);
    }
  } catch (error) {
    console.error('An error occurred:', error);
  }
}

main();

📚 Documentation

With the additional capabilities provided by SheetJS, you can:

• Handle merged cells.
• Convert data formats (e.g., dates, numbers).
• Apply filters and sorting.
• Manipulate worksheet protection status.
• Manage multiple worksheets in a workbook.

For more detailed documentation, refer to the SheetJS Documentation.

🤝 Contribution

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m 'Add amazing feature').
4. Push to the branch (git push origin feature/amazing-feature).
5. Open a Pull Request.

📄 License

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

🙏 Acknowledgments

• Built with SheetJS.
• Part of the Model Context Protocol (MCP) ecosystem.