Golang MCP Server Sdk

🚀 Golang MCP Server SDK Documentation

The Golang MCP Server SDK is a development toolkit designed for quickly building servers that comply with the Model Context Protocol (MCP). It offers a wide range of functional modules and flexible configuration options, enabling developers to easily integrate and extend the MCP protocol.

✨ Features

Public API Packages (pkg/)

• builder/: Used to create server instances through the builder pattern.
• server/: Contains the core implementation logic of the server.
• tools/: Provides utility functions required for creating MCP tools.
• types/: Defines shared types and interfaces.

Private Implementation Details (internal/)

• Contains the internal implementation code of the SDK, which users do not need to use directly.

📦 Installation

No specific installation steps are provided in the original document, so this section is skipped.

💻 Usage Examples

Basic Usage

The SDK provides multiple example projects located in the examples/ directory:

Simple Echo Server

# Run the example
go run examples/echo_server.go

Advanced Calculator Server

# Run in HTTP mode
go run examples/calculator/main.go --mode http

# Run in standard input/output mode
go run examples/calculator/main.go --mode stdio

Advanced Usage

The SDK supports multiple transport protocols based on different usage scenarios:

Standard Input/Output (stdio)

Suitable for command-line tools and direct integration:

// Start a stdio server
if err := mcpServer.ServeStdio(); err != nil {
    fmt.Fprintf(os.Stderr, "Error: %v\n", err)
    os.Exit(1)
}

HTTP Protocol (Supports SSE)

Suitable for web applications, providing real-time communication capabilities:

// Configure the HTTP address
mcpServer.SetAddress(":8080")

// Start an HTTP server
if err := mcpServer.ServeHTTP(); err != nil {
    log.Fatalf("HTTP server error: %v", err)
}

// Graceful shutdown
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
if err := mcpServer.Shutdown(ctx); err != nil {
    log.Fatalf("Server shutdown error: %v", err)
}

Multiple Protocol Support

It is possible to run servers with multiple protocols simultaneously:

// Configure the server to support both HTTP and stdio
mcpServer := server.NewMCPServer("Multi-protocol Server", "1.0.0")
mcpServer.SetAddress(":8080")
mcpServer.AddTool(ctx, echoTool, handleEcho)

// Start the HTTP server in a goroutine
go func() {
    if err := mcpServer.ServeHTTP(); err != nil {
        log.Fatalf("HTTP server error: %v", err)
    }
}()

// Start the stdio server in the main thread
if err := mcpServer.ServeStdio(); err != nil {
    log.Fatalf("Stdio server error: %v", err)
}

📚 Documentation

Testing and Debugging

MCP Monitoring Tool

Use MCP Inspector for testing:

# Test the echo tool
echo '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"echo","parameters":{"message":"Hello, World!"}}}' | go run your_server.go

🔧 Technical Details

No specific technical details (more than 50 words) are provided in the original document, so this section is skipped.

📄 License

MIT License

Copyright (c) [Year] [Author's Name]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

📞 Contact

If you need to contact the developers, please send an email to: [Your Email Address].

Thank you for using the Golang MCP Server SDK!