使用说明

项目简介

Excel MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,它利用 OpenPyXL 库提供强大的 Excel 文件处理功能。该服务器允许LLM客户端通过标准化的 MCP 协议,安全、高效地创建、读取、修改和分析 Excel 文件,而无需在服务器端安装 Microsoft Excel 软件。

主要功能点

  • 全面的Excel功能支持: 提供创建、修改 Excel 工作簿、工作表和单元格范围的完整功能。
  • 数据操作: 支持在 Excel 文件中读取、写入和转换数据。
  • 高级特性: 支持创建和操作图表、透视表,以及进行单元格格式设置和条件格式化。
  • 公式计算: 支持应用和验证 Excel 公式,进行数据计算和分析。
  • 文件管理: 支持本地文件存储,并通过工具上传和下载 Excel 文件。
  • 错误处理: 提供全面的错误处理机制,返回清晰的错误消息,方便调试和问题排查。

安装步骤

  1. 安装 Python: 确保您的系统已安装 Python 3.10 或更高版本。
  2. 安装依赖: 使用 pip 安装项目依赖。打开终端或命令提示符,执行以下命令:
    pip install -U mcp-server openpyxl

服务器配置

MCP 客户端需要配置以下信息以连接到 Excel MCP Server。配置信息为 JSON 格式,示例如下:

{
  "serverName": "excel",  //  自定义服务器名称,用于在客户端中标识
  "command": "uv run excel-mcp-server", //  启动服务器的命令,确保 uv (uvicorn) 已安装
  "transport": "sse",     //  传输协议,本项目使用 SSE
  "env": {
    "EXCEL_FILES_PATH": "/path/to/excel/files"  // (可选) Excel 文件存储路径,默认为 ./excel_files。请替换为实际的文件存储路径
  }
}

配置参数说明:

  • 'serverName': MCP 服务器的名称,客户端使用此名称来引用服务器。
  • 'command': 启动 MCP 服务器的命令。请确保 'uv' 命令可用,您可能需要先安装 'uvicorn' ('pip install uvicorn').
  • 'transport': MCP 服务器使用的传输协议,本项目使用 SSE (Server-Sent Events)。
  • 'env': (可选) 环境变量配置。
    • 'EXCEL_FILES_PATH': (可选) 指定 Excel 文件存储的目录路径。如果未配置,默认使用服务器根目录下的 './excel_files' 目录。您可以根据需要修改此路径。

基本使用方法

  1. 启动服务器: 在终端或命令提示符中,导航到 'excel-mcp' 仓库的根目录,并执行以下命令启动服务器:

    uv run excel-mcp-server

    服务器将以 SSE 模式启动,并监听客户端连接。

  2. 客户端连接: 在 MCP 客户端(例如 Cursor IDE)中,配置服务器连接信息,指定服务器名称、启动命令、传输协议和环境变量(如上文“服务器配置”部分所示)。

  3. 使用 Excel 工具: 客户端成功连接到 Excel MCP Server 后,您可以通过客户端界面或命令调用服务器提供的各种 Excel 工具,例如:

    • 创建新的 Excel 工作簿
    • 在工作表中写入数据
    • 格式化单元格范围
    • 应用 Excel 公式
    • 创建图表和透视表
    • 获取工作簿元数据

    具体可用的工具及其使用方法,请参考服务器代码中的 '@mcp.tool()' 注解定义的方法。

信息

分类

桌面与硬件