Googlesheet MCP

🚀 Google Sheets MCP Server

This MCP server provides tools for interacting with Google Sheets, allowing you to read, write, and update data in spreadsheets.

🚀 Quick Start

This MCP server offers seamless interaction with Google Sheets, enabling you to effortlessly read, write, and update data. Follow the steps below to get started.

✨ Features

• Read, write, and update data in Google Sheets.
• Provide a set of commands to operate on spreadsheets.

📦 Installation

Prerequisites

• Python 3.8 or higher
• A Google Cloud Platform account
• A Google Sheet you want to interact with

Steps

1. Clone this repository:

git clone <your-repository-url>
cd mcp-server-demo

2. Install the required packages:

pip install google-auth-oauthlib google-auth-httplib2 google-api-python-client

3. Download and place the credentials.json file:
   • Download the credentials.json file from your Google Cloud Console.
   • Place the credentials.json file in the same directory as main.py.
   • Ensure the file name is exactly credentials.json.

Configure Google Cloud Platform Credentials

1. Go to Google Cloud Console.

2. Create a new project or select an existing one.

3. Enable the Google Sheets API:

   • Go to "APIs & Services" > "Library".
   • Search for "Google Sheets API".
   • Click "Enable".

4. Create credentials:

   • Go to "APIs & Services" > "Credentials".
   • Click "Create Credentials" > "Service Account".
   • Fill in the service account details:
     • Name: Choose a descriptive name.
     • ID: Automatically generated.
     • Description: Optional description.
   • Click "Create and Continue".
   • For the role, select "Editor" (or an appropriate role as needed).
   • Click "Continue" and then "Done".

5. Create and download the key:

   • In the service account list, click on your newly created account.
   • Go to the "Keys" tab.
   • Click "Add Key" > "Create new key".
   • Select the "JSON" format.
   • Click "Create".
   • The JSON file will be downloaded automatically.

6. Save the credentials:

   • Rename the downloaded JSON file to credentials.json.
   • Place it in the mcp-server-demo directory.

7. Share your Google Sheet:

   • Open your Google Sheet.
   • Click the "Share" button.
   • Add the service account email (found in the client_email field of the credentials.json file).
   • Give it "Editor" access.

Install the MCP Server

1. Download the MCP server:

git clone https://github.com/YOUR_REPO/mcp-server.git
cd mcp-server

2. Install the dependencies:

pip install -r requirements.txt

3. Start the MCP server:

python server.py

💻 Usage Examples

Command List

1. List all commands:

mcp list-commands

2. Get table data:

mcp get-table --spreadsheet_id YOUR_SPREADSHEET_ID --sheet_name YOUR_SHEET_NAME

3. Add a new record:

mcp add-record --spreadsheet_id YOUR_SPREADSHEET_ID --sheet_name YOUR_SHEET_NAME --data "value1,value2\nvalue3,value4"

4. Update a record:

mcp update-record --spreadsheet_id YOUR_SPREADSHEET_ID --sheet_name YOUR_SHEET_NAME --identifier RECORD_IDENTIFIER --updates "column1=value1\ncolumn2=value2"

📚 Documentation

Security Considerations

1. Credential Management:

   • Exclude credentials.json from version control systems.
   • Rotate your credentials regularly.
   • Only share your Google Sheet with necessary service accounts.

2. Permission Control:

   • Ensure the service account email has been added as an editor to the sheet.
   • Verify the validity and security of the credentials.json file.

3. Data Protection:

   • Regularly back up important data.
   • Use HTTPS to transmit sensitive information.
   • Comply with relevant privacy regulations and policies.

Troubleshooting

Common Issues

1. Authentication Errors:

   • Ensure the service account email has been added as an editor to the sheet.
   • Verify the validity and integrity of the credentials.json file.
   • Check if the Google Sheets API is enabled in your Google Cloud project.

2. Permission Errors:

   • Confirm that the service account has the correct permissions.
   • Verify if the sheet has been shared with the service account email.
   • Check if the sheet ID is correct.

3. Data Format Errors:

   • Ensure the data format conforms to the expected structure.
   • Check if the sheet has the required columns (id or name).
   • Verify that the number of data columns matches the sheet.

Contact

If you have any questions or issues, please:

1. Check the error information in the logs.
2. Verify that your settings comply with the above instructions.
3. Ensure all prerequisites are met.
4. Contact aryanpandit17032002@gmail.com