MCP Go Sdk

🚀 MCP-Go SDK

MCP-Go SDK 是一个专为 Go 语言打造的软件开发工具包，用于构建模型通信协议（MCP）工具和服务器。它为实现 MCP 兼容工具提供了基础模块，这些工具可广泛应用于 AI 应用程序，如 Cursor IDE。

🚀 快速开始

查看 servers/example 中的示例服务器，了解实现一个简单的 MCP 工具（用于回显消息）的最小实现：

package main

import (
    "encoding/json"
    "mcp-go/server"
    "mcp-go/transport"
)

// EchoTool 实现了一个简单的回显工具
type EchoTool struct{}

func (t *EchoTool) Name() string {
    return "echo"
}

func (t *EchoTool) Description() string {
    return "A simple echo tool that returns the input message"
}

func (t *EchoTool) Schema() json.RawMessage {
    return json.RawMessage(`{
        "type": "object",
        "properties": {
            "message": {
                "type": "string",
                "description": "The message to echo back"
            }
        },
        "required": ["message"]
    }`)
}

func (t *EchoTool) Execute(params json.RawMessage) (interface{}, error) {
    var input struct {
        Message string `json:"message"`
    }
    if err := json.Unmarshal(params, &input); err != nil {
        return nil, err
    }
    
    return map[string]interface{}{
        "content": []map[string]interface{}{
            {
                "type": "text",
                "text": input.Message,
            },
        },
        "metadata": map[string]interface{}{
            "length": len(input.Message),
        },
    }, nil
}

func main() {
    // 创建一个带有标准输入输出传输的新服务器
    srv := server.NewServer(transport.NewStdioTransport())
    
    // 注册你的工具
    if err := srv.RegisterTool(&EchoTool{}); err != nil {
        panic(err)
    }
    
    // 启动服务器
    if err := srv.Start(); err != nil {
        panic(err)
    }
}

📚 详细文档

✨ 主要特性

• 提供实现 MCP 兼容工具所需的基础模块。
• 支持灵活的传输层，默认提供基于标准输入输出的传输。
• 可用于构建适用于 AI 应用程序的 MCP 工具和服务器。

🔧 技术细节

1. 工具（Tools）

MCP 中的工具是一个可以被 AI 应用程序调用的服务。每个工具必须实现 mcp.Tool 接口：

type Tool interface {
    // Name 返回此工具的唯一标识符
    Name() string
    
    // Description 返回一个人类可读的描述
    Description() string
    
    // Schema 返回工具参数的 JSON 模式
    Schema() json.RawMessage
    
    // Execute 使用给定的参数运行工具
    Execute(params json.RawMessage) (interface{}, error)
}

2. 响应格式（Response Format）

工具应以 MCP 格式的响应返回：

{
    "content": [
        {
            "type": "text",
            "text": "Your response text"
        }
    ],
    "metadata": {
        // 可选的响应元数据
    }
}

3. 传输层（Transport Layer）

SDK 提供了一个灵活的传输层，通过 Transport 接口实现：

type Transport interface {
    // 发送数据包
    Send() error
    
    // 接收数据包
    Receive() ([]byte, error)
    
    // 关闭传输
    Close()
}

默认情况下，SDK 提供了一个基于标准输入输出的传输，用于命令行工具。

4. 配置（Configuration）

要使用 MCP 工具，请在项目根目录下创建一个名为 .mcp.json 的文件，并添加以下内容：

{
    "command": "your_command",
    "args": ["arg1", "arg2"],
    "env": {
        "VAR1": "VALUE1",
        "VAR2": "VALUE2"
    }
}

🤝 贡献指南

要为 MCP-Go SDK 做出贡献，请遵循以下步骤：

1. 报告错误或功能请求：在 GitHub 问题页面 上提交问题。
2. 修复错误或添加新功能：克隆仓库，分支代码并提交您的更改。
3. 添加测试用例：确保为所有新功能和修复添加适当的单元测试。
4. 提交拉取请求：在 GitHub Pull Request 页面 上提交您的更改。

通过遵循这些步骤，您可以帮助改进 MCP-Go SDK 并使其更加完善。