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 並使其更加完善。