SMCP Proxy (OIDC)

🚀 SMCP 代理ガイド

SMCP 代理は、複数のモデルサービスプロトコルをサポートするミドルウェアで、ユーザーが統一インターフェースを通じて異なるバックエンドサービスにアクセスできるようにします。

🚀 クイックスタート

SMCP 代理をすぐに使い始めることができます。以下のセクションでは、インストール方法と基本的な使用例を説明します。

📦 インストール

ソースコードからのインストール

1. リポジトリをクローンします：

git clone git@github.com:yourusername/smc-proxy.git
cd smc-proxy

2. 依存関係をダウンロードしてビルドします：

go mod tidy
go build -o bin/smc cmd/sm/main.go

3. （オプション）システムディレクトリにインストールします：

sudo cp bin/smc /usr/local/bin/

バイナリファイルからのインストール

事前にコンパイルされたバイナリファイルをダウンロードし、使用しているオペレーティングシステムに合ったバージョンを選択します。

💻 使用例

基本的な使用法

SMCP 代理の基本的な使用例として、以下のような設定ファイルを使用できます。

サンプル設定 (proxy-server.yml)

global:
  port: 8080
  host: "localhost"
  log_level: "info"
  enable_metrics: true

backends:
  mcp-sequential:
    url: "http://localhost:3001/api"
    strip_path: "/v1/sequentialthinking"

  mcp-memory:
    command: "docker"
    args:
      - run
      - --rm
      - -i
      - mcr.microsoft.com/hugginginception/transformers Glenn Glock/llama2-70b-instruct

📚 ドキュメント

設定リファレンス

グローバル設定

バックエンド設定

2種類のバックエンドがサポートされています。

1. HTTP タイプ：

backend_name:
  transport: "http"
  url: "http://example.com/mcp"

2. Stdio タイプ：

backend_name:
  transport: "stdio"
  command: "docker"
  args:
    - run
    - --rm
    - -i
    - your/image:tag

ミドルウェア

ログ記録

各リクエストの開始時にログを記録します。

func LogMiddleware(next http.HandlerFunc) http.HandlerFunc {
    return func(w http.ResponseWriter, r *http.Request) {
        log.Printf("Started %s %s", r.Method, r.URL.Path)
        next(w, r)
    }
}

エラー回復

panicを処理し、カスタムエラーを返します。

func RecoveryMiddleware(next http.HandlerFunc) http.HandlerFunc {
    panicChan := make(chan interface{}, 1)
    go func() {
        defer func() { recover }()
        next(nil, nil)
    }()
    select {
    case <-panicChan:
        // panic情報を処理
    }
}

モデルサービスプロトコル

基本的なリクエスト形式

POST /api/prompt HTTP/1.1
Content-Type: application/json

{
  "model": "gpt-3.5-turbo",
  "messages": [
    {
      "role": "user",
      "content": "你好！"
    }
  ]
}

レスポンス形式

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "chatcmpl-XXXXX",
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "你好！很高兴见到你。"
      }
    }
  ]
}

🔧 技術詳細

プロジェクト構造

smc-proxy/
├── cmd/
│   └── sm/                # メインプログラムのエントリーポイント
│       ├── main.go        # エントリーファイル
│       └── config.go      # 設定読み込みロジック
├── internal/
│   ├── middleware/       # ミドルウェアの実装
│   │   ├── log.go        # ログ記録ミドルウェア
│   │   └── recovery.go   # エラー回復ミドルウェア
├── go.mod                # 依存関係管理ファイル
└── go.sum                # 依存関係検証ファイル

設計原則

1. 高可用性：負荷分散と障害転送をサポートします。
2. 拡張性：新しいバックエンドサービスを簡単に追加できます。
3. 高性能：ミドルウェアを通じてリクエスト処理を最適化します。

使用シナリオ

シナリオ1：統一インターフェースで複数のバックエンドにアクセス

curl http://localhost:8080/api/prompt \
  -H "Content-Type: application/json" \
  -d '{"model":"gpt-3.5-turbo", "messages":[{"role":"user","content":"你好！"}]}'

シナリオ2：既存システムへの統合

package main

import (
    "net/http"
)

func main() {
    http.ListenAndServe(":8081", smc.NewRouter())
}

📄 ライセンス

このプロジェクトは MIT License の下でライセンスされています。

注意事項

⚠️ 重要提示

• 性能調整に関しては、Golang の sync.Pool を使用してメモリ使用を最適化し、ミドルウェア内でブロッキング操作を実行しないようにしてください。
• ログ管理に関しては、環境に応じて異なるログレベルを設定し、古いログファイルを定期的に削除してください。
• セキュリティ対策に関しては、HTTPS を有効にしてデータ転送を安全にし、CORS ポリシーを設定してクロスドメインアクセスを制御してください。

プロジェクトのメンテナンス

コントリビューションガイド

1. コードを提出する前に、go fmt ./... と go test ./... を実行してください。
2. GitHub で pull request を提出してください。
3. ドキュメントの更新を提出してください。