Google Sheet MCP Server

🚀 Google Sheets MCP Server

A powerful server implementation based on the Model Context Protocol (MCP), designed for seamless integration with the Google Sheets API, enabling AI assistants to create, read, update, and manage Google Sheets.

🚀 Quick Start

The Google Sheets MCP Server is a robust solution that allows for seamless interaction with Google Sheets. It's built on the Model Context Protocol (MCP), facilitating AI assistants to perform a wide range of operations on Google Sheets.

✨ Features

• Create, read, update, and delete Google Sheets.
• Manage sheet data with cell-level operations.
• Format cells and ranges.
• Share spreadsheets with other users.
• Search for spreadsheets.
• Offer comprehensive authentication options.

📦 Installation

Prerequisites

• Node.js (v16 or higher).
• A Google Cloud project with the Google Sheets API enabled.
• Google Cloud authentication credentials (see below).

Steps

1. Clone the repository:

   git clone https://github.com/yourusername/google-sheets-mcp-server.git
   cd google-sheets-mcp-server
   

2. Install dependencies:

   npm install
   

3. Set up authentication:

   • Create a .env file based on the .env.example template.
   • Add your Google Cloud credentials to it.

4. Build the project:

   npm run build
   

5. Start the server:

   npm start
   

OAuth Setup

For operations requiring user consent (such as creating/editing sheets), you need OAuth credentials:

1. Create OAuth credentials in the Google Cloud Console.
2. Update CLIENT_ID and CLIENT_SECRET in src/get-refresh-token.js.
3. Install the required dependencies:

   npm install open server-destroy
   

4. Run the script to get a refresh token:

   node src/get-refresh-token.js
   

5. Follow the browser prompts to authorize.
6. Copy the refresh token to the .env file.

📚 Documentation

Authentication Options

This MCP server supports multiple authentication methods:

1. Service Account Authentication (Recommended for production)
   • Provide the path to the service account key file.
   • Or directly provide the service account JSON content.
2. API Key Authentication (Easier for development)
   • Provide a Google API key.
3. OAuth2 Authentication (For specific user operations)
   • Provide the OAuth client ID, client secret, and refresh token.

Available Tools

The server provides the following tools:

• google_sheets_create: Create a new Google Sheet.
• google_sheets_get: Get a Google Sheet by ID.
• google_sheets_update_values: Update values in a Google Sheet.
• google_sheets_append_values: Append values to a Google Sheet.
• google_sheets_get_values: Get values from a Google Sheet.
• google_sheets_clear_values: Clear values in a Google Sheet.
• google_sheets_add_sheet: Add a new worksheet to an existing sheet.
• google_sheets_delete_sheet: Delete a worksheet from a sheet.
• google_sheets_list: List Google Sheets available to the authenticated user.
• google_sheets_delete: Delete a Google Sheet.
• google_sheets_share: Share a Google Sheet with a specific user.
• google_sheets_search: Search for Google Sheets by title.
• google_sheets_format_cells: Format cells in a Google Sheet.
• google_sheets_verify_connection: Verify the connection to the Google Sheets API.

💻 Usage Examples

Basic Usage

Here are some examples of using this MCP server with Claude:

Now you can use Google Sheets! Try the following commands:
1. Create a new spreadsheet:
   "Create a new Google Sheet titled 'Monthly Budget'".
2. Add data to the spreadsheet:
   "Add expense categories and amounts to my Monthly Budget spreadsheet".
3. Format the spreadsheet:
   "Make the header row bold and center-aligned".
4. Share the spreadsheet:
   "Share my Monthly Budget spreadsheet with john@example.com".

📄 License

This project is licensed under the MIT License.