MCP Go

🚀 mcp-go

mcp-go is a powerful Go library for implementing servers compatible with the MCP standard of Mark3 Labs. It provides the core functions required for building intelligent agents and AI-driven applications, including tool management, resource provision, and session handling.

🚀 Quick Start

To get started quickly, please refer to the Getting Started documentation.

✨ Features

• Tool Management: Supports adding, deleting, and managing custom tools.
• Resource Provision: Extend the server's functionality through the Resource interface to handle files, databases, or other services.
• Session Support: Context-based session management ensures data isolation between different users.
• Request Hooks: Add callbacks at key points in the request lifecycle to enable monitoring and observability.
• Tool Handler Middleware: Extend the functionality of tool calls through middleware, such as logging and performance monitoring.

📦 Installation

To install mcp-go, use the following command:

go get github.com/mark3labs/mcp-go/server

💻 Usage Examples

Basic Usage

package main

import (
    "context"
    "fmt"
    "log"

    "github.com/mark3labs/mcp-go/server"
)

func main() {
    s := server.NewMCPServer(
        server.WithName("My MCP Server"),
        server.WithVersion("1.0.0"),
        server.WithTools(func(s *server.Server) {
            s.AddTool(mcp.NewTool("echo", func(ctx context.Context, req mcp.CallToolRequest) (*mcp.CallToolResult, error) {
                return mcp.NewToolResultText(req.Tool.Args[0]), nil
            }))
        }),
    )

    log.Println("Starting server on :8080...")
    if err := s.ListenAndServe(":8080"); err != nil {
        fmt.Printf("Server exited with error: %v\n", err)
    }
}

Advanced Usage

Creating a Server Instance

s := server.NewMCPServer(
    server.WithName("My MCP Server"),
    server.WithVersion("1.0.0"),
)

Adding a Tool

s.AddTool(mcp.NewTool("echo", func(ctx context.Context, req mcp.CallToolRequest) (*mcp.CallToolResult, error) {
    return mcp.NewToolResultText(req.Tool.Args[0]), nil
}))

Deleting a Tool

s.DeleteTool("echo")

Adding a Resource

s.AddResource(mcp.NewResource("file", func(ctx context.Context, req mcp.CallResourceRequest) (*mcp.ResourceResult, error) {
    // Handle file requests
}))

Getting the Current Session

ctx := context.WithValue(context.Background(), server.SessionKey, "my-session-id")
s.ServeHTTP(ctx, w, r)

Adding a Hook

s.AddHook(server.HookTypeRequestStart, func(r *server.Server, ctx context.Context) {
    log.Println("Request started")
})

Adding Middleware

s.AddMiddleware(mcp.MiddlewareFunc(func(ctx context.Context, next mcp.ToolHandler) mcp.ToolHandler {
    return func(ctx context.Context, req mcp.CallToolRequest) (*mcp.CallToolResult, error) {
        log.Println("Before processing tool")
        result, err := next(ctx, req)
        log.Println("After processing tool")
        return result, err
    }
}))

📚 Documentation

• English:

  • Getting Started
  • API Reference
  • Tool Management
  • Resource Management

• Chinese:

  • 快速入门
  • API 参考
  • 工具管理
  • 资源管理

🤝 Contribution Guidelines

Contributions are welcome! Please refer to the Developer Guide to learn how to contribute.