Update README for GDrive

This commit is contained in:
Mahesh Murag 2024-11-19 19:49:33 -05:00
commit 73b13a044d
No known key found for this signature in database

View file

@ -2,13 +2,35 @@
This MCP server integrates with Google Drive to allow listing, reading, and searching over files. 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 ## Getting started
1. Create a new Google Cloud project 1. [Create a new Google Cloud project](https://console.cloud.google.com/projectcreate)
2. Enable the Google Drive API 2. [Enable the Google Drive API](https://console.cloud.google.com/workspace-api/products)
3. Configure an OAuth consent screen ("internal" is fine for testing) 3. [Configure an OAuth consent screen](https://console.cloud.google.com/apis/credentials/consent) ("internal" is fine for testing)
4. Add OAuth scope `https://www.googleapis.com/auth/drive.readonly` 4. Add OAuth scope `https://www.googleapis.com/auth/drive.readonly`
5. Create an OAuth Client ID for application type "Desktop App" 5. [Create an OAuth Client ID](https://console.cloud.google.com/apis/credentials/oauthclient) for application type "Desktop App"
6. Download the JSON file of your client's OAuth keys 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 7. Rename the key file to `gcp-oauth.keys.json` and place into the root of this repo
@ -30,4 +52,4 @@ After authenticating:
1. Run the server normally: `node build/gdrive` 1. Run the server normally: `node build/gdrive`
2. The server will load the saved credentials and start 2. The server will load the saved credentials and start
Note: If you haven't authenticated yet, the server will prompt you to run with the `auth` argument first. Note: If you haven't authenticated yet, the server will prompt you to run with the `auth` argument first.