Googlesheets MCP Server

🚀 Google Sheets API MCP Server

This server enables operations such as creating, reading, updating, and deleting Google Sheets, and provides access to spreadsheet data through MCP resources.

🚀 Quick Start

Prerequisites

• Node.js version 16 or higher.
• The Google Sheets API enabled in your Google Cloud Platform project.
• OAuth 2.0 credentials (Client ID, Client Secret, Refresh Token).

Installation and Configuration

1. Clone this repository.
2. Install dependencies:

   npm install
   

3. Create a .env file based on .env.example and enter your Google API credentials:

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

Running the Server

npm start

Development Mode

npm run dev

Testing via MCP Inspector

npm run inspect

✨ Features

• Create, read, update, and delete spreadsheets.
• Manage worksheets within spreadsheets.
• Read, write, append, and clear values.
• Handle developer metadata.
• Access spreadsheet data through MCP resources.

💻 Usage Examples

Spreadsheet Management

• createSpreadsheet: Create a new spreadsheet.
• getSpreadsheet: Get detailed information about a spreadsheet.
• batchUpdate: Apply multiple updates to a spreadsheet.

Worksheet Management

• copySheet: Copy a worksheet to another spreadsheet.
• addSheet: Add a new worksheet to a spreadsheet.
• deleteSheet: Delete a worksheet from a spreadsheet.
• updateSheetProperties: Update worksheet properties.

Value Management

• getValues: Get values from a range.
• updateValues: Update values within a range.
• appendValues: Append values to a range.
• clearValues: Clear values within a range.
• batchGetValues: Get values from multiple ranges.
• batchUpdateValues: Update values in multiple ranges.

Developer Metadata

• getDeveloperMetadata: Get all developer metadata.
• createDeveloperMetadata: Create new developer metadata.
• updateDeveloperMetadata: Update existing developer metadata.
• deleteDeveloperMetadata: Delete developer metadata.

📚 Documentation

Available Resources

• sheets://spreadsheet/{spreadsheetId}: Get detailed information about a spreadsheet.
• sheets://spreadsheet/{spreadsheetId}/sheet/{sheetName}: Get detailed information about a worksheet.
• sheets://spreadsheet/{spreadsheetId}/values/{range}: Get values from a range.
• sheets://spreadsheet/{spreadsheetId}/metadata: Get all developer metadata.

Authentication

This server uses OAuth 2.0 for authentication in conjunction with the Google Sheets API. You need to provide the following credentials in the .env file:

• CLIENT_ID: Your Google API client ID.
• CLIENT_SECRET: Your Google API client secret.
• REDIRECT_URI: The redirect URI configured in your Google API project.
• REFRESH_TOKEN: The refresh token obtained through the OAuth 2.0 process.

📄 License

MIT