使用 protoc-gen-go-mcp 的最佳实践教程

1. 项目介绍

protoc-gen-go-mcp 是一个用于生成 Go 语言的 MCP（Master Control Program）协议代码的插件。它基于 Google 的 Protocol Buffers 编译器 protoc，用于将 .proto 文件转换成 Go 代码，同时生成与 MCP 协议兼容的数据结构和方法。

2. 项目快速启动

首先，确保你已经安装了 Go 语言环境和 Protocol Buffers 编译器 protoc。

安装 protoc-gen-go-mcp

go install github.com/redpanda-data/protoc-gen-go-mcp

创建 .proto 文件

创建一个名为 example.proto 的 Protocol Buffers 定义文件：

syntax = "proto3";

package example;

// 定义一个简单的消息
message Person {
  string name = 1;
  int32 id = 2;
  string email = 3;
}

生成 Go 代码

使用 protoc 和 protoc-gen-go-mcp 插件生成 Go 代码：

protoc --go_out=. --mcp_out=. example.proto

执行上述命令后，你将得到两个文件：example.pb.go 和 example.pb.mcp.go。

3. 应用案例和最佳实践

定义 MCP 服务

在 .proto 文件中定义 MCP 服务：

service ExampleService {
  rpc GetPerson (PersonRequest) returns (PersonResponse);
}

message PersonRequest {
  string name = 1;
}

message PersonResponse {
  Person person = 1;
}

生成 MCP 服务代码

使用 protoc-gen-go-mcp 插件生成 MCP 服务代码：

protoc --go_out=. --mcp_out=. example_service.proto

实现 MCP 服务

在 Go 代码中实现定义的服务：

package example

import (
  "context"
  "fmt"
  "github.com/redpanda-data/protoc-gen-go-mcp/mcp"
)

type Server struct {
  // 可以定义服务需要的任何状态
}

func (s *Server) GetPerson(ctx context.Context, req *PersonRequest) (*PersonResponse, error) {
  // 实现业务逻辑
  person := &Person{
    Name:  req.Name,
    Id:    123,
    Email: "[e-mail]",
  }
  return &PersonResponse{Person: person}, nil
}

func RegisterExampleService(s *mcp.Server, srv Server) {
  s.RegisterService(&ExampleServiceDesc, srv)
}

启动 MCP 服务器

package main

import (
  "github.com/redpanda-data/protoc-gen-go-mcp/mcp"
  "example"
)

func main() {
  s := mcp.NewServer()

  // 注册服务
  example.RegisterExampleService(s, &example.Server{})

  // 启动服务器
  if err := s.Serve(":50051"); err != nil {
    fmt.Println("Failed to serve:", err)
  }
}

4. 典型生态项目

protoc-gen-go-mcp 可以与多种生态项目配合使用，例如：

• gRPC: 使用 MCP 生成代码与 gRPC 服务进行通信。
• Consul: 集成 MCP 服务的服务发现。
• Prometheus: 集成 MCP 服务的监控。

通过上述步骤，你可以快速开始使用 protoc-gen-go-mcp 并将其应用于你的项目。