Basemcpserver

🚀 基礎サーバー Docker イメージ

この基礎イメージは、MCP サーバーを実行するために特別に設計されており、HTTP と標準入出力（stdin/stdout）を通じた通信をサポートしています。Python で実装され、Starlette フレームワークと Uvicorn サーバーに基づいています。

🚀 クイックスタート

実行例

Docker を使用する場合

1. イメージをダウンロードします：

   docker pull yourusername/base-mcp-server:latest
   

2. コンテナを実行します（HTTP モード）：

   docker run -p 7501:7501 yourusername/base-mcp-server:latest
   

3. または、標準入出力モードで実行します：

   docker run --rm -it yourusername/base-mcp-server:latest stdio
   

ビルドスクリプトを使用する場合

./build.sh build

サンプルプロジェクト構造

your-project/
├── requirements.txt                 # プロジェクトの依存関係
├── Dockerfile                       # Docker ファイル
├── config.py                        # 設定ファイル
└── your_server.py                   # サーバーの実装

✨ 主な機能

• 2 種類の通信モードをサポートしています：

  • HTTP/SSE：HTTP プロトコルを通じた Server-Sent Events (SSE) 通信。
  • 標準入出力（_stdio）：stdin と stdout を直接通じた通信。

• 自動化された API ドキュメント生成と対話型テストインターフェースを提供します。

📦 インストール

インストール手順

1. イメージをダウンロードします：

   docker pull yourusername/base-mcp-server:latest
   

2. コンテナを実行します（HTTP モード）：

   docker run -p 7501:7501 yourusername/base-mcp-server:latest
   

3. または、標準入出力モードで実行します：

   docker run --rm -it yourusername/base-mcp-server:latest stdio
   

設定

環境変数

• HOST：バインドするインターフェース。デフォルトは 0.0.0.0。
• PORT：リッスンするポート。デフォルトは 7501。
• API_KEY：必須。認証に使用されます。
• SERVER_NAME：サーバーの一意の識別子。

設定方法

1. コマンドライン環境変数を使用する：

docker run -p 7501:7501 \
  -e API_KEY=your_api_key \
  -e SERVER_NAME=your-mcp-server \
  yourusername/your-mcp-server:latest

2. 環境ファイルを使用する：

.env ファイルを作成します：

API_KEY=your_api_key
SERVER_NAME=your-mcp-server
HOST=0.0.0.0
PORT=7501

実行時に環境ファイルを指定します：

docker run -p 7501:7501 --env-file .env yourusername/your-mcp-server:latest

3. Docker Secrets を使用する：

シークレットを設定します：

docker secret create api_key your_api_key

実行時にシークレットを参照します：

docker run -p 7501:7501 -e API_KEY=$(docker secret inspect --format='{{.Data}}' api_key) yourusername/your-mcp-server:latest

💻 使用例

基本的な使用法

# Docker でイメージをダウンロード
docker pull yourusername/base-mcp-server:latest
# HTTP モードでコンテナを実行
docker run -p 7501:7501 yourusername/base-mcp-server:latest

高度な使用法

# サーバー機能を拡張する例
from base_mcp_server import BaseMCPServer

class MyMCPServer(BaseMCPServer):
    def __init__(self, config):
        super().__init__(config)
        # カスタム初期化コードを追加

📚 ドキュメント

サーバー機能の拡張

BaseMCPServer クラスを継承することで、サーバー機能を簡単に拡張できます。

自動化されたドキュメント生成

サーバーを起動した後、http://localhost:7501/docs にアクセスすると、自動化された API ドキュメントを確認できます。

対話型テストインターフェース

サーバーを起動した後、http://localhost:7501/test にアクセスして対話型テストを行うことができます。

🔧 技術詳細

コアコンポーネント

• Starlette：HTTP リクエストを処理するための軽量 ASGI フレームワーク。
• Uvicorn：Starlette アプリケーションを実行するための ASGI サーバー。
• Python ネイティブ I/O：標準入出力モードに使用されます。

⚠️ 重要提示

⚠️ 重要提示

環境変数を通じて API キーなどの機密情報を直接渡すべきではありません。Docker Secrets の使用をおすすめします。

デフォルトでは、コンテナはすべてのインターフェースにバインドされます (HOST=0.0.0.0)。本番環境では適切なネットワークセキュリティポリシーを設定してください。

📄 ライセンス

このプロジェクトは MIT ライセンスに従います。
Copyright (c) 2024, Your Name.