MCP HubMCP Hub
modelcontextprotocol

gdrive

by: modelcontextprotocol

This MCP server integrates with Google Drive to allow listing, reading, and searching over files.

0created 19/11/2024
Visit
GoogleDrive
API

📌Overview

Purpose: The primary goal of the Google Drive server is to facilitate integration with Google Drive for file listing, reading, and searching capabilities.

Overview: This server acts as a bridge between applications and Google Drive, allowing users to interact with their files seamlessly. It supports various file types including Google Workspace documents, which are automatically exported to standard formats.

Key Features:

  • File Search Tool: Enables users to search for files in Google Drive using a query string, returning the names and MIME types of matching files to improve file accessibility and management.

  • File Access Support: Allows access to all file types stored in Google Drive, with automatic export of Google Workspace files (Docs, Sheets, Presentations, Drawings) into widely used formats (Markdown, CSV, Plain text, PNG), while other files remain in their native formats for easy retrieval and use.


Google Drive Server

This MCP server integrates with Google Drive to allow listing, reading, and searching over files.

Components

Tools

  • search
    • Search for files in Google Drive
    • Input: query (string): Search query
    • Returns file names and MIME types of matching files

Resources

The server provides access to Google Drive files:

  • Files (gdrive:///<file_id>)
    • Supports all file types
    • Google Workspace files are automatically exported:
      • Docs → Markdown
      • Sheets → CSV
      • Presentations → Plain text
      • Drawings → PNG
    • Other files are provided in their native format

Getting Started

  1. Create a new Google Cloud project
  2. Enable the Google Drive API
  3. Configure an OAuth consent screen ("internal" is fine for testing)
  4. Add OAuth scope https://www.googleapis.com/auth/drive.readonly
  5. Create an OAuth Client ID for application type "Desktop App"
  6. Download the JSON file of your client's OAuth keys
  7. Rename the key file to gcp-oauth.keys.json and place into the root of this repo (e.g., servers/gcp-oauth.keys.json)

Make sure to build the server with either npm run build or npm run watch.

Authentication

To authenticate and save credentials:

  1. Run the server with the auth argument: node ./dist auth
  2. This will open an authentication flow in your system browser
  3. Complete the authentication process
  4. Credentials will be saved in the root of this repo (e.g., servers/.gdrive-server-credentials.json)

Usage with Desktop App

To integrate this server with the desktop app, add the following to your app's server configuration:

Docker

Authenticate the server with the following command, replacing /path/to/gcp-oauth.keys.json with the path to your OAuth keys file:

docker run -i --rm --mount type=bind,source=/path/to/gcp-oauth.keys.json,target=/gcp-oauth.keys.json -v mcp-gdrive:/gdrive-server -e GDRIVE_OAUTH_PATH=/gcp-oauth.keys.json -e "GDRIVE_CREDENTIALS_PATH=/gdrive-server/credentials.json" -p 3000:3000 mcp/gdrive auth

The command will print the URL to open in your browser. Open this URL and complete the authentication process. The credentials will be saved in the mcp-gdrive volume.

Once authenticated, use the server in your app's server configuration:

{
  "mcpServers": {
    "gdrive": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "-v", "mcp-gdrive:/gdrive-server", "-e", "GDRIVE_CREDENTIALS_PATH=/gdrive-server/credentials.json", "mcp/gdrive"]
    }
  }
}

NPX

{
  "mcpServers": {
    "gdrive": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-gdrive"
      ]
    }
  }
}

License

This MCP server is licensed under the MIT License. You are free to use, modify, and distribute the software subject to the terms of the MIT License. For more details, please see the LICENSE file in the project repository.