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