MCP Excel Reader

MCP Excel Reader

一个用于读取 Excel 文件的模型上下文协议（MCP）服务，支持自动分块和分页。该工具基于 SheetJS 和 TypeScript 构建，可通过自动将大型 Excel 文件拆分为易于处理的数据块，帮助你高效处理这些文件。

功能

• 📊 读取 Excel 文件（.xlsx、.xls），并自动限制文件大小
• 🔄 自动对大型数据集进行分块
• 📑 选择工作表并分页读取行
• 📅 正确处理日期
• ⚡ 针对大型文件进行了优化
• 🛡️ 错误处理和验证

安装

通过 Smithery 安装

要通过 Smithery 自动为 Claude Desktop 安装 Excel Reader：

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

作为 MCP 服务

1. 全局安装：

npm install -g @archimdescrypto/excel-reader

2. 添加到 MCP 设置文件中（通常位于 ~/.config/claude/settings.json 或同等位置）：

{
  "mcpServers": {
    "excel-reader": {
      "command": "excel-reader",
      "env": {}
    }
  }
}

用于开发

1. 克隆仓库：

git clone https://github.com/ArchimdesCrypto/mcp-excel-reader.git
cd mcp-excel-reader

2. 安装依赖：

npm install

3. 构建项目：

npm run build

用法

用法

Excel Reader 提供了一个工具 read_excel，参数如下：

interface ReadExcelArgs {
  filePath: string;      // Path to Excel file
  sheetName?: string;    // Optional sheet name (defaults to first sheet)
  startRow?: number;     // Optional starting row for pagination
  maxRows?: number;      // Optional maximum rows to read
}

// Response format
interface ExcelResponse {
  fileName: string;
  totalSheets: number;
  currentSheet: {
    name: string;
    totalRows: number;
    totalColumns: number;
    chunk: {
      rowStart: number;
      rowEnd: number;
      columns: string[];
      data: Record<string, any>[];
    };
    hasMore: boolean;
    nextChunk?: {
      rowStart: number;
      columns: string[];
    };
  };
}

基本用法

与 Claude 或其他兼容 MCP 的 AI 搭配使用时：

Read the Excel file at path/to/file.xlsx

AI 将使用该工具读取文件，并自动对大型文件进行分块处理。

功能

1. 自动分块

   • 自动将大型文件拆分为易于处理的数据块
   • 默认数据块大小为 100KB
   • 提供分页元数据

2. 选择工作表

   • 按名称读取指定工作表
   • 如果未指定，则默认读取第一个工作表

3. 行分页

   • 使用 startRow 和 maxRows 控制读取哪些行
   • 获取下一数据块的信息，以便连续读取

4. 错误处理

   • 验证文件是否存在及其格式
   • 提供清晰的错误消息
   • 妥善处理格式错误的 Excel 文件

扩展 SheetJS 功能

Excel Reader 基于 SheetJS 构建，可通过其强大功能进行扩展：

可用扩展

1. 公式处理

   // Enable formula parsing
   const wb = XLSX.read(data, {
     cellFormula: true,
     cellNF: true
   });
   

2. 单元格格式

   // Access cell styles and formatting
   const styles = Object.keys(worksheet)
     .filter(key => key[0] !== '!')
     .map(key => ({
       cell: key,
       style: worksheet[key].s
     }));
   

3. 数据验证

   // Access data validation rules
   const validation = worksheet['!dataValidation'];
   

4. 工作表功能

   • 合并单元格：worksheet['!merges']
   • 隐藏行/列：worksheet['!rows']、worksheet['!cols']
   • 工作表保护：worksheet['!protect']

如需了解更多功能和详细文档，请访问 SheetJS 文档。

贡献

1. Fork 此仓库
2. 创建功能分支（git checkout -b feature/amazing-feature）
3. 提交更改（git commit -m 'Add some amazing feature'）
4. 推送到分支（git push origin feature/amazing-feature）
5. 创建 Pull Request

许可证

本项目采用 MIT License，详情请参阅 LICENSE 文件。

致谢

• 基于 SheetJS 构建
• 属于 模型上下文协议 生态系统的一部分