使用说明
项目简介
MCP Google Sheets 集成服务是一个实现了 Model Context Protocol (MCP) 的后端服务。它基于 Node.js 构建,利用 Google Sheets API,允许大型语言模型 (LLM) 通过标准化的 MCP 协议,安全、便捷地与 Google Sheets 进行交互,实现数据的读取和写入。它为 LLM 应用提供了一个连接电子表格数据的能力层。
主要功能点
- 读取数据 ('gsheets_read'): 提供一个名为 'gsheets_read' 的工具。LLM 可以调用此工具来从指定的 Google Sheet 电子表格和单元格范围中读取数据。例如,获取某个库存表格的当前数据。
- 写入数据 ('gsheets_write'): 提供一个名为 'gsheets_write' 的工具。LLM 可以调用此工具向指定的 Google Sheet 电子表格的某个范围写入结构化数据。例如,记录新的销售订单、产品信息或其他结构化数据。
安装步骤
- 安装 Node.js: 确保您的系统已安装 Node.js (建议版本 23 或更高)。您可以从 Node.js 官方网站下载并安装。
- 克隆仓库: 使用 Git 将此 GitHub 仓库克隆到您的本地机器上。
git clone https://github.com/Demontie/mcp-google-sheets.git cd mcp-google-sheets - 安装依赖: 在项目根目录下运行以下命令安装所需的 Node.js 依赖包。
npm install - 配置 Google Sheets API 凭证:
- 前往 Google Cloud Console 创建或选择一个项目。
- 在项目下启用 Google Sheets API (搜索 "Google Sheets API" 并启用)。
- 创建一个服务账号 (Service Account)。
- 为该服务账号生成并下载 JSON 格式的 API 密钥文件。将下载的文件重命名为 'credentials.json'。
- 将 'credentials.json' 文件放置在您克隆的 'mcp-google-sheets' 项目的根目录下。
- 共享 Google Sheet: 打开您希望此服务访问的 Google Sheet 电子表格,点击“分享”按钮,将服务账号的邮箱地址(可以在 'credentials.json' 文件中找到)添加为编辑者。
服务器配置
该 MCP 服务是一个后端进程,需要被支持 MCP 协议的客户端应用(如 Cursor IDE)启动和管理。您需要在您的 MCP 客户端的配置中添加此服务的信息。
配置通常位于客户端的设置文件中,格式为 JSON。您需要添加一个条目到 'mcpServers' 配置项下,指定一个唯一的服务名称(例如:'"google-sheets"'),以及如何启动该服务的命令和参数。
- 命令 ('command'): 指向 Node.js 可执行文件的路径。
- 参数 ('args'): 包含启动此 MCP 服务的脚本路径,例如指向您本地仓库中 'src/index.ts' 文件(或其编译后的 JavaScript 文件)的绝对路径。如果直接运行 TypeScript 文件,可能需要额外的配置或使用 'ts-node',具体取决于您的 Node.js 环境和客户端的能力。
请务必将配置中的文件路径替换为您本地仓库的实际绝对路径。具体的配置格式和步骤请参考您使用的 MCP 客户端应用的官方文档。
基本使用方法
配置完成后,启动您的 MCP 客户端。客户端会根据配置自动尝试启动并连接到 MCP Google Sheets 集成服务。一旦连接建立,客户端中的 LLM 便能感知到服务器提供的 'gsheets_read' 和 'gsheets_write' 工具。
您可以通过与 LLM 对话来利用这些工具。例如,您可以指示 LLM "从我的销售电子表格中读取最新数据" 或 "将新的产品信息写入库存表格"。LLM 会识别出需要使用 'gsheets_read' 或 'gsheets_write' 工具,并根据对话内容尝试提取所需的参数(如电子表格 ID、要读写的范围、要写入的数据)。
如果调用工具时缺少必需的参数,服务器端的 'InteractiveHandler' 可能会通过 MCP 协议向客户端发送提示信息,请求您提供缺失的信息,以便 LLM 能够继续执行任务。
信息
分类
数据库与文件