Remote MCP

🚀 Remote-MCP Project Documentation

Remote-MCP is a solution for the remote model context protocol, aiming to achieve remote access and centralized management of model contexts. It is a type-safe, bidirectional communication framework that supports custom headers and basic authentication middleware.

🚀 Quick Start

Client Configuration

1. Install the client package:

   npm install @remote-mcp/client
   

2. Create a local MCP service:

   import { MCPRouter, LogLevel } from "@remote-mcp/client";
   
   const mcpRouter = new MCPRouter({
     logLevel: LogLevel.DEBUG,
     name: "example-client",
     version: "1.0.0",
   });
   
   // Add custom tools or commands
   mcpRouter.addTool(
     "calculator",
     {
       description: "Perform basic calculations.",
       schema: z.object({
         operation: z.enum(["add", "subtract", "multiply", "divide"]),
         a: z.string(),
         b: z.string(),
       }),
     },
     async (args) => {
       // Handle calculation logic
       return {
         content: [{ type: "text", text: `${result}` }],
       };
     }
   );
   
   // Start the service
   mcpRouter.listen(9512);
   

Server Implementation

1. Install the server package:

   npm install @remote-mcp/server
   

2. Create a remote MCP service:

   import { MCPRouter, LogLevel } from "@remote-mcp/server";
   import { createHTTPServer } from '@trpc/server/adapters/standalone';
   
   const mcpRouter = new MCPRouter({
     logLevel: LogLevel.DEBUG,
     name: "example-server",
     version: "1.0.0",
     capabilities: {
       logging: {},
     },
   });
   
   // Add example tools
   mcpRouter.addTool(
     "calculator",
     {
       description:
         "Perform basic calculations. Add, subtract, multiply, divide.",
       schema: z.object({
         operation: z.enum(["add", "subtract", "multiply", "divide"]),
         a: z.string(),
         b: z.string(),
       }),
     },
     async (args) => {
       const a = Number(args.a);
       const b = Number(args.b);
   
       switch (args.operation) {
         case "add":
           return { content: [{ type: "text", text: `${a + b}` }] };
         case "subtract":
           return { content: [{ type: "text", text: `${a - b}` }] };
         // Other operations...
       }
     }
   );
   
   // Start the HTTP service
   createHTTPServer({
     router: mcpRouter,
   }).start({ port: 9512 });
   

✨ Features

Core Components

1. @remote-mcp/client: A client library that runs as a local MCP service and connects to the remote implementation.
2. @remote-mcp/server: A server-side library for creating remotely accessible MCP services.

Functional Features

• Basic type-safe client/server communication.
• Support for basic MCP commands, tools, and prompt functions.
• Provide HTTP header support (including custom headers and authentication middleware).
• Initial improvements in error handling and basic middleware support.

Example Architecture

The following is an example architecture diagram of Remote-MCP:

📚 Documentation

Why is this library needed now?

Current MCP implementations are limited to local use and cannot meet the needs of remote access and centralized management. Remote-MCP solves this pain point by providing extensibility for the model context protocol and supporting more advanced features.

Existing Package Dependencies

• @remote-mcp/client: Used for client communication.
• @remote-mcp/server: Used for server-side implementation.
• trpc: Supports TRPC-based remote procedure calls.

Future Development Roadmap

Planned Features

1. Improve error handling: Enhance the error handling mechanism to improve the user experience.
2. Support more protocols: Expand support for more communication protocols.
3. Enhance security: Add more security features, such as SSL support and token verification.

How to Contribute?

Welcome community members to participate in the project!

• Submit issue reports: GitHub Issues
• Submit code fixes or new features: Pull Request

Disclaimer

This project is for experimental purposes only and is not suitable for production environments. Please read the documentation carefully and ensure thorough testing before use.

License

The project follows the MIT license. For specific terms, please refer to the LICENSE file.

References

1. MCP Protocol Documentation: Link
2. TRPC Documentation: Link

Thank you for reading! For further information, please visit the project's GitHub repository or refer to the relevant documentation.