使用说明

项目简介

Google Sheets MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在为LLM(大型语言模型)客户端提供与 Google Sheets 电子表格交互的能力。通过此服务器,LLM可以读取、写入、更新和管理 Google Sheets 中的数据,从而扩展LLM在数据处理和自动化方面的应用场景。

主要功能点

  • 数据访问: 允许LLM客户端读取Google Sheets电子表格中的数据,支持读取整个表格、特定工作表、行列数据等。
  • 数据编辑: 支持LLM客户端修改Google Sheets数据,包括编辑单元格、行、列,插入行列,以及重命名工作表和文档。
  • 工具集成: 提供一系列预定义的工具,如创建电子表格、列出工作表、读取数据、编辑数据等,方便LLM客户端调用。
  • 身份验证: 内置Google Sheets API的身份验证处理,简化客户端配置。
  • 资源管理: 将Google Sheets电子表格作为资源进行管理,LLM客户端可以通过资源URI访问电子表格数据。

安装步骤

  1. 下载代码: 从 GitHub 仓库 https://github.com/D-unn/google-sheets-mcp 下载源代码压缩包或克隆仓库。
  2. 解压文件: 将下载的压缩包解压到本地目录。
  3. 安装依赖: 打开终端,导航到项目根目录,运行命令 'npm install' 安装项目依赖。
  4. 配置API访问: 根据仓库中的 'CONFIG.md' 文件(如果存在,或者参考Google Sheets API文档),在 Google Cloud Console 中创建项目并启用 Google Sheets API,获取API密钥或配置OAuth 2.0 客户端凭据,并将凭据文件 'gcp-oauth.keys.json' 放置在项目根目录的 'dist' 文件夹中(如果使用默认配置,或者根据实际的凭据文件路径进行放置)。首次运行服务器时,会引导您完成OAuth授权流程,授权后凭据将保存在 '.gsheets-server-credentials.json' 文件中。
  5. 运行服务器: 在终端中,于项目根目录运行命令 'node index.js' 启动 MCP 服务器。

服务器配置 (MCP 客户端配置)

为了让 MCP 客户端连接到 Google Sheets MCP Server,您需要在客户端配置中指定服务器的启动信息。以下是一个 JSON 格式的配置示例,您需要将其添加到您的 MCP 客户端配置中。

{
  "serverName": "google-sheets-mcp",
  "command": "node",
  "args": [ "index.js" ]
}

配置参数说明:

  • 'serverName': 服务器名称,设置为 'google-sheets-mcp'。
  • 'command': 运行服务器的命令,这里使用 'node' (确保您的环境中已安装 Node.js)。
  • 'args': 传递给 'node' 命令的参数,指定服务器入口文件为 'index.js'。

请注意: MCP客户端通常会读取这个JSON配置,并使用 'command' 和 'args' 来启动 MCP 服务器进程。您需要确保 Node.js 环境可用,并且 'index.js' 文件存在于 MCP 客户端能够访问到的相对路径或绝对路径中 (通常 MCP 客户端和 MCP 服务器部署在同一环境中,使用相对路径即可)。

基本使用方法

  1. 启动服务器: 按照上述安装步骤启动 Google Sheets MCP Server。
  2. 配置 MCP 客户端: 在您的 MCP 客户端应用中,配置上述服务器连接信息。
  3. 连接服务器: 启动 MCP 客户端,客户端将自动连接到 Google Sheets MCP Server。
  4. 使用工具: 通过 MCP 客户端,您可以调用服务器提供的各种工具来操作 Google Sheets。例如,使用 'read_all_from_sheet' 工具读取指定电子表格和工作表的所有数据,或使用 'edit_cell' 工具修改单元格内容。具体的工具和参数请参考代码中的 'ListToolsRequestSchema' 和 'CallToolRequestSchema' 的定义。
  5. 资源访问: 客户端可以使用 'gsheets:///' 协议的 URI 来引用 Google Sheets 电子表格资源,例如 'gsheets:///your_spreadsheet_id'。服务器将根据 URI 提供电子表格的 CSV 数据。

信息

分类

生产力应用