Googlesheets MCP Server

🚀 Google Sheets API MCP 服务端

本服务端可与 Google Sheets API 集成，提供了创建、读取、更新和删除电子表格等功能，还能管理工作表、处理值和开发者元数据，方便开发者通过 MCP 资源访问电子表格数据。

🚀 快速开始

要使用此服务端，您需要满足以下先决条件并完成安装配置：

• 先决条件：
  • Node.js 16 或更高版本
  • 已启用 Google Cloud Platform 项目中的 Google Sheets API
  • OAuth 2.0 凭证（客户 ID、客户秘密、刷新令牌）
• 安装配置：
  1. 克隆此仓库。
  2. 安装依赖：

  npm install
  

  3. 根据 .env.example 创建一个 .env 文件，输入您的 Google API 凭证：

  CLIENT_ID=your_client_id
  CLIENT_SECRET=your_client_secret
  REDIRECT_URI=your_redirect_uri
  REFRESH_TOKEN=your_refresh_token
  

✨ 主要特性

• 创建、读取、更新和删除电子表格
• 管理电子表格中的工作表
• 读取、写入、追加和清除值
• 处理开发者元数据
• 通过 MCP 资源访问电子表格数据

📦 安装指南

1. 克隆此仓库。
2. 安装依赖：

   npm install
   

3. 根据 .env.example 创建一个 .env 文件，输入您的 Google API 凭证：

   CLIENT_ID=your_client_id
   CLIENT_SECRET=your_client_secret
   REDIRECT_URI=your_redirect_uri
   REFRESH_TOKEN=your_refresh_token
   

💻 使用示例

运行服务器

npm start

开发模式

npm run dev

通过 MCP Inspector 测试

npm run inspect

📚 详细文档

可用工具

电子表格管理

• createSpreadsheet：创建新电子表格
• getSpreadsheet：获取电子表格详细信息
• batchUpdate：对电子表格应用多个更新

工作表管理

• copySheet：将工作表复制到另一个电子表格
• addSheet：向电子表格添加新的工作表
• deleteSheet：从电子表格删除工作表
• updateSheetProperties：更新工作表属性

值管理

• getValues：从范围中获取值
• updateValues：更新范围内的值
• appendValues：向范围追加值
• clearValues：清除范围内的值
• batchGetValues：从多个范围获取值
• batchUpdateValues：更新多个范围内的值

开发者元数据

• getDeveloperMetadata：获取所有开发者元数据
• createDeveloperMetadata：创建新的开发者元数据
• updateDeveloperMetadata：更新现有开发者元数据
• deleteDeveloperMetadata：删除开发者元数据

可用资源

• sheets://spreadsheet/{spreadsheetId}：获取电子表格详细信息
• sheets://spreadsheet/{spreadsheetId}/sheet/{sheetName}：获取工作表详细信息
• sheets://spreadsheet/{spreadsheetId}/values/{range}：从范围中获取值
• sheets://spreadsheet/{spreadsheetId}/metadata：获取所有开发者元数据

认证

此服务器使用 OAuth 2.0 进行认证，与 Google Sheets API 结合。您需要在 .env 文件中提供以下凭证：

• CLIENT_ID：您的 Google API 客户端 ID
• CLIENT_SECRET：您的 Google API 客户端秘密
• REDIRECT_URI：在您的 Google API 项目中配置的重定向 URI
• REFRESH_TOKEN：通过 OAuth 2.0 流程获得的刷新令牌

📄 许可证

MIT