Mcp4go

🚀 MCP4Go 中文文檔

MCP4Go 是 模型上下文協議 (MCP) 的純 Go 語言實現方案，它通過抽象協議複雜性，極大地簡化了 AI 應用程序的開發流程，為開發者提供了便捷高效的開發體驗。

🚀 快速開始

要在 MCP4Go 中開啟開發之旅，只需將包導入到您的 Go 應用程序中，以下是一個完整的示例代碼：

package main

import (
	"context"
	"fmt"
	"log"
	"os"
	"os/signal"
	"syscall"
	"time"

	"github.com/mcp4go/mcp4go/pkg/logger"
	"github.com/mcp4go/mcp4go/protocol"
	"github.com/mcp4go/mcp4go/server"
	"github.com/mcp4go/mcp4go/server/iface"
	"github.com/mcp4go/mcp4go/server/transport"

	_ "time/tzdata" // 加載所有時區
)

func main() {
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
	_logger := logger.DefaultLog

	// 監聽中斷信號以實現優雅關閉
	signalCh := make(chan os.Signal, 1)
	signal.Notify(signalCh, os.Interrupt, syscall.SIGTERM)
	go func() {
		<-signalCh
		_logger.Logf(ctx, logger.LevelWarn, "接收到了關閉信號")
		cancel()
	}()

	type timeRequest struct {
		TimeZone string `json:"time_zone,omitempty" description:"時區，默認為 Asia/Shanghai"`
	}

	// 創建標準輸入輸出傳輸層
	stdioTransport := transport.NewDefault()

	// 創建服務器實例
	srv, err := server.NewServer(server.WithLogger(_logger),
		server.WithTransport(stdioTransport),
		server.WithToolDefinitions(func() *iface.ToolDefinitions {
			td := iface.NewToolDefinitions()
			promptTemplate := `{{.ToolPrefix}}: {{.Name}}{{if .Version}}-v{{.Version}}{{end}}：{{.Description}}`

			toolDef := td.Add("time", "獲取當前時間", "返回指定時區的當前時間")
			toolDef.AddParameter("timeZone", &iface.ToolParameter{
				Type:        "string",
				Description: "目標時區，例如 'Asia/Shanghai' 或 'UTC'",
				Default:     "Asia/Shanghai",
			})

			return td
		}()),
	)
	if err != nil {
		log.Printf("Failed to create server: %v\n", err)
		return
	}
	defer srv.Close()

	// 啟動服務器
	_logger.Logf(ctx, logger.LevelWarn, "啟動 Time MCP 服務器")
	if err := srv.Run(ctx); err != nil {
		_logger.Logf(ctx, logger.LevelError, "服務器錯誤: %v", err)
		return
	}

	_logger.Logf(ctx, logger.LevelWarn, "服務器關閉完成")
}

✨ 主要特性

• 純 Go 實現：採用純 Go 語言完成完整的 MCP 協議實現，保證了代碼的簡潔性和高效性。
• 高級別抽象：提供常見 MCP 資源的高級別抽象，降低開發難度。
• 可擴展架構：具備可擴展架構，支持開發者進行自定義擴展。
• 詳盡文檔與示例：提供詳盡的文檔和示例，方便開發者快速上手。
• 生產環境就緒：具備穩健的錯誤處理機制，可直接用於生產環境。

📦 安裝指南

MCP4Go 需要 Go 1.18 或更高版本，您可以使用 Go 模塊進行安裝，具體命令如下：

go get github.com/mcp4go/mcp4go

📚 詳細文檔

MCP4Go 提供完整的 Model Context Protocol 實現，支持以下功能：

• JSON-RPC 通信：實現高效的 JSON-RPC 通信機制。
• 資源生命週期管理：對資源的生命週期進行有效管理。
• 提示工程設計：支持提示工程設計，優化交互體驗。
• 工具定義與調用：方便進行工具的定義與調用。
• 採樣參數設置：可靈活設置採樣參數。
• 日誌記錄和診斷：提供完善的日誌記錄和診斷功能。

📄 許可證

本項目採用 MIT 許可證。

👥 如何貢獻

歡迎廣大開發者貢獻代碼！請查閱我們的 CONTRIBUTING.md 瞭解更多貢獻信息。