MCP 服务器

Google Sheets API MCP Server

mattcoatsworth

开发者工具

README

Google Sheets API MCP 服务器

一个全面的模型上下文协议 (MCP) 服务器，用于与 Google Sheets API 交互。该服务器提供用于管理电子表格、工作表、值和开发者元数据的工具和资源。

## 功能特性

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

## 前提条件

- Node.js 16 或更高版本
- 启用了 Google Sheets API 的 Google Cloud Platform 项目
- 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
   ```

## 用法

### 运行服务器

```
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