【亲测免费】 MCP-golang 开源项目教程

1. 项目介绍

MCP-golang 是一个非官方的 Model Context Protocol（MCP）在 Go 语言中的实现。它允许开发者使用几行代码就可以编写 MCP 服务器和客户端。MCP-golang 旨在提供类型安全、自定义传输、低模板代码、模块化以及双向通信的支持。

2. 项目快速启动

以下是快速启动 MCP-golang 项目的步骤：

首先，确保你已经安装了 Go 环境。

go get github.com/metoro-io/mcp-golang

然后，创建一个简单的服务器：

package main

import (
    "fmt"
    "github.com/metoro-io/mcp-golang"
    "github.com/metoro-io/mcp-golang/transport/stdio"
)

type Content struct {
    Title       string `json:"title" jsonschema:"required,description=The title to submit"`
    Description *string `json:"description" jsonschema:"description=The description to submit"`
}

type MyFunctionsArguments struct {
    Submitter string     `json:"submitter" jsonschema:"required,description=The name of the thing calling this tool"`
    Content   Content    `json:"content" jsonschema:"required,description=The content of the message"`
}

func main() {
    server := mcp_golang.NewServer(stdio.NewStdioServerTransport())

    err := server.RegisterTool("hello", "Say hello to a person", func(arguments MyFunctionsArguments) (*mcp_golang.ToolResponse, error) {
        return mcp_golang.NewToolResponse(mcp_golang.NewTextContent(fmt.Sprintf("Hello, %s!", arguments.Submitter))), nil
    })

    if err != nil {
        panic(err)
    }

    err = server.RegisterPrompt("prompt_test", "This is a test prompt", func(arguments Content) (*mcp_golang.PromptResponse, error) {
        return mcp_golang.NewPromptResponse("description", mcp_golang.NewPromptMessage(mcp_golang.NewTextContent(fmt.Sprintf("Hello, %s!", arguments.Title)), mcp_golang.RoleUser)), nil
    })

    if err != nil {
        panic(err)
    }

    err = server.RegisterResource("test://resource", "resource_test", "This is a test resource", "application/json", func() (*mcp_golang.ResourceResponse, error) {
        return mcp_golang.NewResourceResponse(mcp_golang.NewTextEmbeddedResource("test://resource", "This is a test resource", "application/json")), nil
    })

    if err != nil {
        panic(err)
    }

    server.Serve()
}

这段代码创建了一个简单的 MCP 服务器，注册了一个工具、一个提示和一个资源，然后开始服务。

3. 应用案例和最佳实践

3.1 创建 HTTP 服务器

除了标准输入输出传输，MCP-golang 也支持 HTTP 传输。

// 使用标准 HTTP 传输
transport := http.NewHTTPTransport("/mcp")
transport.WithAddr(":8080")
server := mcp_golang.NewServer(transport)

// 或者使用 Gin 框架
transport := http.NewGinTransport()
router := gin.Default()
router.POST("/mcp", transport.Handler())
server := mcp_golang.NewServer(transport)

请注意，HTTP 传输是无状态的，并且不支持双向通信的特性，如通知。如果你需要这些特性，请使用标准输入输出传输。

3.2 客户端使用

以下是一个使用 MCP-golang 客户端的例子：

package main

import (
    "context"
    "log"
    "github.com/metoro-io/mcp-golang"
    "github.com/metoro-io/mcp-golang/transport/stdio"
)

type CalculateArgs struct {
    Operation string `json:"operation"`
    A         int    `json:"a"`
    B         int    `json:"b"`
}

func main() {
    // ...
    // 创建和初始化客户端
    transport := stdio.NewStdioServerTransportWithIO(stdout, stdin)
    client := mcp.NewClient(transport)
    if _, err := client.Initialize(context.Background()); err != nil {
        log.Fatalf("Failed to initialize: %v", err)
    }
    // ...
    // 调用带有类型安全参数的工具
    args := CalculateArgs{
        Operation: "add",
        A:         10,
        B:         5,
    }
    response, err := client.CallTool(context.Background(), "calculate", args)
    // ...
}

这个例子展示了如何创建一个 MCP 客户端，并通过它调用一个工具。

4. 典型生态项目

MCP-golang 作为 Model Context Protocol 的 Go 语言实现，可以与多种生态系统和项目进行集成。以下是一些可能的使用场景：

• 集成到现有的 Go 服务中，为它们提供 MCP 协议的支持。
• 创建自定义的客户端和服务器，用于特定的应用场景，如自动化测试、数据处理等。
• 与其他开源项目合作，扩展 MCP-golang 的功能，如添加新的传输方式、工具或资源类型。

通过上述教程，开发者应该能够快速上手并开始使用 MCP-golang 进行项目开发。