MCP Server Boilerplate

🚀 MCP 基礎

Model Context Protocol (MCP) サーバーを構築するための、本番環境で使用可能な拡張性の高いテンプレートです。Python を使用して、MCP サーバーを迅速に作成、拡張、およびデプロイし、ツール、プロンプト、およびリソースを大規模言語モデル（LLM）およびエージェントクライアントに公開できます。

🚀 クイックスタート

このセクションでは、MCP 基礎サーバーをすばやくセットアップして起動する手順を説明します。

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

git clone [仓库地址]
cd mcp-base

2. 依存関係をインストールします：

pip install -r requirements.txt

3. 環境を設定します： .env.example を .env にコピーし、必要な値を入力します。

4. サーバーを起動します：

python src/server.py

✨ 主な機能

このテンプレートには、以下のような素晴らしい機能が備わっています。

• 多様なトランスポートサポート： STDIO、SSE、HTTP などのトランスポートをサポートしています（/src/transports/ を参照）
• モジュール化されたツール/プロンプト/リソース： 新しい機能を追加するには、クラスを作成して登録するだけです
• 型安全な入力検証： Pydantic を使用したスキーママッチング
• 最高レベルのセキュリティ実践： ファイルとプロセスをサンドボックス化し、不正アクセスを防止します
• 迅速なデプロイ： Docker コンテナ化をサポートし、本番環境でのデプロイを簡素化します

🏗️ アーキテクチャの概要

以下は、このプロジェクトのディレクトリ構造です。

.
├── src/
│   ├── base/                # ツール、プロンプト、およびリソースのための基本クラス
│   ├── tools/               # サンプルツール（ファイルシステム、API、プロンプトなど）
│   ├── resources/           # サンプルリソース（静的/動的）
│   ├── prompts/             # サンプルプロンプト（テキスト生成、要約など）
│   ├── transports/          # トランスポート層の実装とドキュメント
│   │   ├── stdio/
│   │   │   └── README.md
│   │   ├── sse/
│   │   │   └── README.md
│   │   └── ...
│   ├── config.py            # 設定と環境管理
│   ├── server.py            # サーバーのインスタンス化と登録
│   └── main.py              # エントリポイント：トランスポート層を選択し、サーバーを起動
├── tests/                   # ツール/リソースのサンプルテスト
├── Dockerfile               # コンテナ化デプロイ用のファイル
├── requirements.txt / pyproject.toml
├── README.md                # このファイル
├── CONTRIBUTING.md
└── ...

📚 ドキュメント

このセクションでは、MCP 基礎サーバーの使い方について詳しく説明します。

• 基本的な使い方： MCP 基礎サーバーの起動と設定方法を学びます。
• 高度なトピック： カスタムトランスポート層の探索や機能モジュールの拡張などの高度な使い方を学びます。

💻 使用例

基本的な使用法

新しいツールを作成する方法を示します。

src/tools/ ディレクトリに新しいツールクラスを作成します：

class NewTool:
    def __init__(self):
        self.name = "NewTool"

    def execute(self, command):
        # 具体的なロジックを実装します
        pass

config.py にツールを登録します：

TOOLS = [
    NewTool()
]

高度な使用法

基本クラスを継承してカスタム動作を実装することで、サーバーの機能を簡単に拡張できます。

🔧 技術詳細

このテンプレートは、特定のサーバー実装ではなく、Python のスタートアップテンプレートです。これは、独自の MCP サーバーを構築するためのモジュール化された、良く文書化された基礎を提供し、STDIO、SSE、HTTP などの複数のトランスポート層をサポートします。また、セキュリティ、拡張性、および保守性の面でのベストプラクティスを示しています。

🚀 貢献とサポート

このプロジェクトの fork を歓迎します！MCP Base を改善するために、pull request または issue を送信することをお勧めします。

💬 コミュニティとサポート

以下のリンクから、私たちのコミュニティに参加し、より多くの支援とサポートを得ることができます。

• Discord： リンク
• Reddit： リンク
• GitHub ディスカッション： リンク

MCP Base は、すべての新しい Python MCP サーバープロジェクトにおすすめのスタート地点です。ぜひ fork して拡張し、改善に貢献してください！