Remote MCP

🚀 Remote MCP Server

This is an MCP (Model Context Protocol) server based on Cloudflare Worker, which provides various tool APIs, including features such as Gmail and Google Calendar. This project is developed using TypeScript and utilizes the @remote-mcp/server library to simplify the implementation of the MCP server.

✨ Features

• Serverless architecture based on Cloudflare Workers
• Provides Gmail email sending and reading functions
• Provides Google Calendar event creation and listing functions
• Integrates OAuth2 authentication
• Uses Durable Objects for state management

📦 Installation

# Clone the repository
git clone https://github.com/yourusername/remote-mcp-server.git
cd remote-mcp-server

# Install dependencies
npm install

📚 Configuration

OAuth Configuration

1. Create a project in the Google Cloud Console.
2. Enable the Gmail API and Google Calendar API.
3. Create an OAuth client ID and secret.
4. Modify the OAuth configuration in the src/config.ts file.

export const GOOGLE_OAUTH_CONFIG = {
  clientId: 'Your client ID',
  clientSecret: 'Your client secret',
  redirectUri: 'https://your-worker.your-subdomain.workers.dev/oauth/gmail/callback',
  scopes: [
    'https://www.googleapis.com/auth/gmail.send',
    'https://www.googleapis.com/auth/gmail.readonly',
    'https://www.googleapis.com/auth/calendar',
    'https://www.googleapis.com/auth/calendar.events'
  ]
};

Cloudflare KV Namespace Configuration

For the production environment, you need to configure the KV namespace to store OAuth tokens:

1. Create a KV namespace in the Cloudflare Dashboard.
2. Obtain the KV namespace ID.
3. Uncomment the KV configuration section in wrangler.jsonc and add your namespace ID:

"kv_namespaces": [
  {
    "binding": "OAUTH_KV",
    "id": "Your KV namespace ID"
  }
]

🚀 Building and Deployment

Local Development

# Run the development server
npm run dev

Deployment to Cloudflare Workers

# Build and deploy
npm run deploy

📁 Project Structure

remote-mcp-server/
├── src/                  # Source code
│   ├── index.ts          # Main entry file
│   ├── config.ts         # Configuration file
│   ├── services/         # Service implementation
│   │   └── google.ts     # Google services (Gmail, Calendar)
│   └── utils.ts          # Utility functions
├── dist/                 # Compiled files
├── static/               # Static resources
├── build.js              # Build script
└── wrangler.jsonc        # Cloudflare Workers configuration

📄 API Endpoints

• /tools - Get the list of available tools
• /api/mcp - MCP API endpoint
• /oauth/gmail - OAuth login path
• /oauth/callback - OAuth callback handling path

🔧 Troubleshooting

Common Issues

1. Deployment errors: Check if the KV namespace is correctly configured.
2. OAuth errors: Ensure that the redirect URI is consistent with the settings in the Google Cloud Console.
3. Durable Objects issues: Confirm that Durable Objects are correctly initialized and have the necessary permissions.

Solutions

1. Deployment errors:
   • Ensure that the correct KV namespace ID is filled in wrangler.jsonc.
   • Check if the KV storage service is enabled in your Cloudflare account.
2. OAuth errors:
   • In the Google Cloud Console, ensure that the allowed redirect URIs include the path you set.
   • Check if the client ID and secret are correctly filled in.
3. Durable Objects issues:
   • Ensure that Durable Objects are correctly initialized in the code and have access to the relevant resources.

🤝 Contribution Guidelines

1. Fork the repository: Fork this project on GitHub.
2. Create a feature branch: Create a new branch for new features or bug fixes based on the main branch.
3. Submit your code: Commit your changes and push them to the remote repository.
4. Create a Pull Request: Initiate a Pull Request in the original project repository.

📄 License

This project is licensed under the MIT License. The specific content is as follows:

MIT License

Copyright (c) [Year] [Author's Name]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Thank you for your attention and support for this project! If you have any questions or suggestions, please feel free to contact the project maintainers.