Scaled MCP

🚀 Scaled - MCP プロジェクトドキュメント

Scaled - MCP は、ツールの登録や実行を管理するためのサービスです。このドキュメントでは、Scaled - MCP の使い方やサンプルコードについて説明します。

🚀 クイックスタート

MCP の使用例

package main

import (
    "context"
    "log"

    "github.com/traego/scaled-mcp/v2/resources"
)

func main() {
    // ツールレジストリを作成
    registry := resources.NewStaticToolRegistry()

    // 電卓ツールを登録
    calculatorTool := resources.NewTool("calculator").
        WithDescription("基本的な算術演算を実行する").
        WithString("operation").
        Required().
        Description("実行する操作（加法、減法、乗法、除法）").
        Add().
        WithNumber("a").
        Required().
        Description("最初の操作数").
        Add().
        WithNumber("b").
        Required().
        Description("2番目の操作数").
        Add().
        Build()

    registry.Register(calculatorTool)

    // コンテキストとツールプロバイダを作成
    ctx := context.Background()
    toolProvider := resources.NewToolProvider(registry)

    // MCP サービスを作成
    cfg := resources.DefaultConfig()
    mcpServer, err := resources.NewMcpServer(cfg,
        resources.WithToolRegistry(registry),
    )

    if err != nil {
        log.Fatal(err)
    }

    defer mcpServer.Stop()

    // MCP サーバーを起動
    go func() {
        <-mcpServer.Start()
    }()

    // 例：コンテキストを作成し、計算操作を実行
    ctx, cancel := context.WithCancel(ctx)
    defer cancel()

    // 加法演算を実行
    result, err := resources.NewToolInvocation("calculator").
        WithStringMapParameter("operation", "add").
        WithNumber(10).
        Add().
        WithNumber(20).
        Add().
        Invoke(ctx, toolProvider)

    if err != nil {
        log.Fatal(err)
    }

    log.Printf("計算結果： %v", result.Value)
}

実行結果

$ go run main.go 
計算結果： 30

💻 使用例

基本的な使用法

上記の MCP の使用例が基本的な使い方を示しています。

高度な使用法

以下は、静的ツールレジストリと動的ツールレジストリを使用した例です。

静的ツールレジストリの使用例

package main

import (
    "context"
    "log"

    "github.com/traego/scaled-mcp/v2/resources"
)

func main() {
    // 静的ツールレジストリを作成
    registry := resources.NewStaticToolRegistry()

    // 電卓ツールを登録
    calculatorTool := resources.NewTool("calculator").
        WithDescription("基本的な算術演算を実行する").
        WithString("operation").
        Required().
        Description("実行する操作（加法、減法、乗法、除法）").
        Add().
        WithNumber("a").
        Required().
        Description("最初の操作数").
        Add().
        WithNumber("b").
        Required().
        Description("2番目の操作数").
        Add().
        Build()

    registry.Register(calculatorTool)

    // コンテキストとツールプロバイダを作成
    ctx := context.Background()
    toolProvider := resources.NewToolProvider(registry)

    // MCP サービスを作成
    cfg := resources.DefaultConfig()
    mcpServer, err := resources.NewMcpServer(cfg,
        resources.WithToolRegistry(registry),
    )

    if err != nil {
        log.Fatal(err)
    }

    defer mcpServer.Stop()

    // MCP サーバーを起動
    go func() {
        <-mcpServer.Start()
    }()

    // 例：コンテキストを作成し、計算操作を実行
    ctx, cancel := context.WithCancel(ctx)
    defer cancel()

    // 加法演算を実行
    result, err := resources.NewToolInvocation("calculator").
        WithStringMapParameter("operation", "add").
        WithNumber(10).
        Add().
        WithNumber(20).
        Add().
        Invoke(ctx, toolProvider)

    if err != nil {
        log.Fatal(err)
    }

    log.Printf("計算結果： %v", result.Value)
}

動的ツールレジストリの使用例

package main

import (
    "context"
    "log"

    "github.com/traego/scaled-mcp/v2/resources"
)

func main() {
    // 動的ツールレジストリを作成
    registry := resources.NewDynamicToolRegistry()

    // 電卓ツールを登録
    calculatorTool := resources.NewTool("calculator").
        WithDescription("基本的な算術演算を実行する").
        WithString("operation").
        Required().
        Description("実行する操作（加法、減法、乗法、除法）").
        Add().
        WithNumber("a").
        Required().
        Description("最初の操作数").
        Add().
        WithNumber("b").
        Required().
        Description("2番目の操作数").
        Add().
        Build()

    registry.Register(calculatorTool)

    // コンテキストとツールプロバイダを作成
    ctx := context.Background()
    toolProvider := resources.NewToolProvider(registry)

    // MCP サービスを作成
    cfg := resources.DefaultConfig()
    mcpServer, err := resources.NewMcpServer(cfg,
        resources.WithToolRegistry(registry),
    )

    if err != nil {
        log.Fatal(err)
    }

    defer mcpServer.Stop()

    // MCP サーバーを起動
    go func() {
        <-mcpServer.Start()
    }()

    // 例：コンテキストを作成し、計算操作を実行
    ctx, cancel := context.WithCancel(ctx)
    defer cancel()

    // 加法演算を実行
    result, err := resources.NewToolInvocation("calculator").
        WithStringMapParameter("operation", "add").
        WithNumber(10).
        Add().
        WithNumber(20).
        Add().
        Invoke(ctx, toolProvider)

    if err != nil {
        log.Fatal(err)
    }

    log.Printf("計算結果： %v", result.Value)
}

⚠️ 重要な注意事項

1. goroutine を使用したリクエスト処理

高い並行性を保つために、各リクエストの処理に goroutine を使用することをおすすめします。

// MCP サーバー起動後、各新しい接続を処理
go func() {
    for {
        // 新しいクライアント接続を待機
        conn, err := listener.Accept()
        if err != nil {
            log.Printf("受け入れエラー： %v", err)
            continue
        }

        // goroutine を使用してリクエストを処理
        go handleConnection(conn)
    }
}()

2. MCP サーバーの停止

アプリケーションが終了する前に、MCP サーバーを適切に停止してリソースを解放してください。

defer mcpServer.Stop()

📋 今後の予定

• ログ記録の実装：デバッグや監視を容易にするために、詳細なログ記録を追加します。
• エラー処理の改善：エラーが発生した場合に適切に処理できるように、エラー処理メカニズムを改善します。
• パフォーマンスの最適化：実際のニーズに応じて、goroutine の数を調整したり、より効率的な通信方法を使用したりして、パフォーマンスを最適化します。

🤝 貢献ガイド

コードスタイル

Go 言語のコード規約に従い、既存のコードとの一貫性を保ってください。

コミットガイド

1. コミットする前に、すべての単体テストを通過していることを確認してください。
2. コミットメッセージは簡潔で明確に、関連する機能や修正内容を含めてください。

🔑 サンプルの重要な部分

• ツールの登録：registry.Register(tool) を使用して、ツールをレジストリに追加します。
• ツールの呼び出し：resources.NewToolInvocation を使用してツール呼び出しを作成し、チェーンメソッドでパラメータを設定します。
• コンテキスト管理：context.Background() と context.WithCancel を適切に使用して、リクエストのライフサイクルを管理します。

🐞 問題の報告

問題が発生した場合は、プロジェクトの Issues に報告するか、直接メンテナに連絡してください。