Google Workspace MCP

🚀 Google Workspace MCP Documentation

Google Workspace MCP (Management Console Plugin) is a tool for unified management and integration of Google Workspace services. It supports the following features:

• Account Management: Create, authenticate, and delete Google Workspace accounts.
• File Operations: Upload, download, share files, and manage file permissions.
• Calendar Integration: Create, query, and subscribe to calendar events.
• Mail Handling: Send emails, manage mail lists, and set up email filters.

🚀 Quick Start

📦 Installation

Installation Steps

1. Clone the code repository:

   git clone https://github.com/your-repository.git
   cd google-workspace-mcp
   

2. Install dependencies:

   npm install
   

3. Configure environment variables:

   • Create and edit the config/mcp-config.json file with the following content:

     {
       "google": {
         "client_id": "YOUR_GOOGLE_CLIENT_ID",
         "client_secret": "YOUR_GOOGLE_CLIENT_SECRET",
         "redirect_uri": "http://localhost:3000/callback"
       }
     }
     

4. Start the service:

   npm start
   

💻 Usage Examples

Account Management

Authentication Process

1. Execute the authentication command:

   authenticate_workspace_account --email your.email@gmail.com
   

2. Follow the prompts to complete the OAuth 2.0 authentication process.

Account List

Display information about all authenticated accounts:

list_accounts

File Operations

Upload a File

Upload a local file to Google Drive:

upload_drive_file --file /path/to/your/file.pdf --parent_folder "Documents"

Download a File

Download a specified file:

download_drive_file --id file_id_123456

Calendar Integration

Create a Calendar Event

Add a new calendar event:

create_calendar_event --title 会议提醒 --description 项目讨论 --start_time "2023-10-01T14:00:00"

📚 Documentation

For detailed usage instructions, please refer to the API Documentation.

Future Plans

New Services

• Admin SDK Support
• Integration with More Google Services

🔧 Technical Details

Unit Testing Methods

1. Simplified Mocking

   • Use static mock responses to ensure test predictability.
   • Avoid complex end-to-end mocking in unit tests.
   • Test one functional module at a time.
   • Mock external dependencies (e.g., OAuth, file system) with simple implementations.

2. Test Organization

   • Group tests by functionality (e.g., account operations, file operations).
   • Use clear and descriptive test names.
   • Keep tests focused and independent.
   • Reset mocks and modules between tests.

3. Mock Management

   • Use jest.resetModules() to ensure a clean state.
   • Require modules after mock changes.
   • Explicitly track mock function calls.
   • Validate function calls and their results.

4. File System Testing

   • Use simple JSON structures for testing.
   • Focus on data correctness rather than format.
   • Test error scenarios (e.g., missing files, invalid JSON).
   • Validate file operations without getting into implementation details.

5. OAuth Mocking

   • Fully mock the OAuth process to avoid actual authorization.
   • Ensure the test environment is isolated from the production environment.

Best Practices

Security Considerations

• Credential Management: It is recommended to store Google OAuth credentials (client_id and client_secret) in a secure location, such as an encrypted configuration file or environment variables.
• Access Control: Implement strict permission policies to ensure that only authorized users can perform sensitive operations.

Performance Optimization

• Asynchronous Processing: For large data operations, it is recommended to use asynchronous methods to improve efficiency.
• Error Handling: Add appropriate error catching and recovery mechanisms to critical operations to prevent service interruptions.

Troubleshooting

Common Issues

1. Authentication Failure

   • Confirm that the provided email address is correct and valid.
   • Check that the OAuth credentials are configured correctly.

2. API Request Timeout

   • Verify the network connection status.
   • Consider increasing the request timeout setting or optimizing the data transfer volume.

Appendix

Command-Line Tool Reference

• authenticate_workspace_account: Perform OAuth authentication for Google Workspace accounts.
• list_accounts: Display information about all authenticated Google Workspace accounts.
• upload_drive_file: Upload a file to a specified Google Drive folder.
• download_drive_file: Download a Google Drive file with a specific ID.
• create_calendar_event: Create a new calendar event.

Contact Information

If you need help or feedback, please contact:

• Email: support@googlworkspace.com
• Phone: +1 (800) 123-4567