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 了解更多贡献信息。