Template MCP Server

🚀 Python MCP サーバーテンプレート

このテンプレートは、MCP (Model Context Protocol) サーバーの作成と管理に使用できる汎用的なPythonテンプレートです。本テンプレートは、本番環境でのMCPサーバーのベストプラクティスに沿っており、構造化された開発フレームワークを提供することで、プロジェクトを迅速に開始できます。

🚀 クイックスタート

プロジェクト構造

template-mcp-server/
├── src/
│   ├── server.py                 # メインプログラムのエントリーポイント
│   └── mcp_server/              # コア機能パッケージ
│       ├── config.py            # 設定の読み込みと管理
│       ├── logger.py            # ログモジュール
│       ├── service_client.py    # サービスクライアントの実装
│       └── errors.py           # カスタムエラークラスの定義
├── requirements.txt          # プロジェクトの依存関係管理
└── .env.example              # 環境変数のサンプルファイル

依存関係のインストール

pip install -r requirements.txt

✨ 主な機能

• 構造が明確: 完全なコードディレクトリ構造とファイルのサンプルを提供します。
• ログシステム: 柔軟なログ記録メカニズムが統合されており、デフォルトでINFOレベルのログをサポートしています。
• 設定管理: Pydanticモデルを使用して設定管理と環境変数の処理を行います。
• エラー処理: 統一的なエラー捕捉と応答メカニズムが実装されています。
• サービス状態: サービスの初期化とクリーンアッププロセスを提供し、リソース管理を正しく行います。

📚 ドキュメント

使用説明

環境変数の設定

以下の環境変数を設定することで、サーバーの動作を構成できます。

• SERVICE_API_KEY: あなたのサービスAPIキー（必須）
• SERVICE_ENDPOINT: サービスエンドポイントのURL（デフォルト: https://api.example.com）
• SERVICE_TIMEOUT: リクエストのタイムアウト時間（単位: 秒、デフォルト: 30）
• LOG_LEVEL: ログレベル（デフォルト: INFO）

サーバーの起動

# 基本的な起動方法
python src/server.py

# カスタム設定を使用する場合
SERVICE_API_KEY=test python src/server.py

開発ガイド

設定管理

Pydanticモデルを使用して設定を読み込み、検証します。

from pydantic import BaseSettings

class Settings(BaseSettings):
    api_key: str
    endpoint: str = "https://api.example.com"
    timeout: int = 30
    log_level: str = "INFO"

settings = Settings(_env_file=["./.env", ""])

ログシステム

簡単なログ記録クラスを実装します。

import logging

class Logger:
    def __init__(self, name: str, level: int = logging.INFO):
        self.logger = logging.getLogger(name)
        self.logger.setLevel(level)
        handler = logging.StreamHandler()
        formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
        handler.setFormatter(formatter)
        self.logger.addHandler(handler)

    def info(self, message: str):
        self.logger.info(message)

    def error(self, message: str):
        self.logger.error(message)

    def debug(self, message: str):
        self.logger.debug(message)

サービスクライアント

汎用的なサービスクライアントを実装します。

import httpx

class ServiceClient:
    def __init__(self, endpoint: str, timeout: int):
        self.client = httpx.Client(base_url=endpoint, timeout=timeout)

    async def fetch_data(self, path: str) -> dict:
        try:
            response = await self.client.get(path)
            response.raise_for_status()
            return response.json()
        except Exception as e:
            raise ServiceError(f"Failed to fetch data from {path}: {str(e)}")

テストガイド

手動テスト

# 基本的な実行
python src/server.py

# DEBUGレベルで起動
LOG_LEVEL=DEBUG python src/server.py

統合テスト

統合テストケースを作成します。

import pytest
from fastapi.testclient import TestClient

from server import app

client = TestClient(app)

def test_health_check():
    response = client.get("/health")
    assert response.status_code == 200
    assert "status" in response.json()

リソース

• FastAPI公式ドキュメント
• Pydantic公式ドキュメント
• HttpX公式ドキュメント

ベストプラクティス

コードスタイル

PEP8とGoogle Pythonコードスタイルガイドに従ってください。

ドキュメント作成

すべてのパブリックAPIに詳細なコメントと使用説明を記述してください。

バージョン管理

Semantic Versioning (MAJOR.MINOR.PATCH) 規範に従ってバージョン管理を行ってください。

📄 ライセンス

MIT License

このテンプレートに従うことで、さまざまなビジネスニーズを満たす安定したMCPサーバーを迅速に構築できます。