What is Grpcmcp

grpcmcp is a simple MCP Server designed to proxy requests to a gRPC backend. It can operate using a provided descriptors file or leverage gRPC reflection for dynamic service discovery.

Use cases

Common use cases for grpcmcp include integrating multiple gRPC services, providing a unified endpoint for client applications, and enabling real-time data streaming through SSE.

How to use

To use grpcmcp, first install the binary using ‘go install .’. Then, run an example gRPC server with ‘go run example/main.go’. Finally, start grpcmcp with the command ‘grpcmcp --hostport=localhost:3000 --reflect’ to enable SSE transport.

Key features

Key features of grpcmcp include support for SSE transport, the ability to use gRPC reflection or descriptor files for service discovery, filtering of gRPC services, and the option to attach bearer tokens for authorization.

Where to use

grpcmcp can be used in various domains such as microservices architecture, API gateways, and real-time applications where gRPC services need to be accessed or proxied.

grpcmcp

A simple MCP server that will proxy to a grpc backend based on a provided descriptors file or using reflection.

Quick Start

1. Install the binary: go install . or go install github.com/adiom-data/grpcmcp Ensure the go bin directory is in your PATH.

2. In a terminal, run the example grpc server go run example/main.go. This will start a grpc health service on port 8090 with server reflection enabled. Note that this runs on the default port that grpcmcp will connect to.

3. SSE Transport In another terminal, run grpcmcp --hostport=localhost:3000 --reflect. Specifying hostport will use SSE. The SSE endpoint will be served at http://localhost:3000/sse.

4. STDIN Transport Set up the MCP config. e.g.

"grpcmcp": {
    "command": "grpcmcp",
    "args": ["--reflect"]
}

Options / Features

grpcmcp --help for a full list of options.

• hostport string - When set, use SSE, and this serves as the server host:port.

• descriptors string - Specify file location of the protobuf definitions generated from buf build -o protos.pb or protoc --descriptor_set_out=protos.pb instead of using gRPC reflection.

• reflect - If set, use reflection to retrieve gRPC endpoints instead of descriptor file.

• url string - Specify the url of the backend server.

• services string - Comma separated list of fully qualified gRPC service names to filter.

• bearer string - Token to attach in an Authorization: Bearer header.

• bearer-env string - Environment variable for token to attach in an Authorization: Bearer header. Overrides bearer.

• header string (repeatable) - Headers to add in Key: Value format.

Help

Join our Discord at https://discord.gg/hDjx3DehwG