MCP Framework

🚀 MCP フレームワーク開発ガイド

MCP（Model Context Protocol）は、スマートアプリケーションの開発とデプロイに使用されるオープンソースのフレームワークです。統一されたプロトコル、ツール、サービスを提供し、開発者が効率的なアプリケーションを迅速に構築できるよう支援します。

✨ 主な機能

• 統一プロトコル：標準化されたインターフェースを提供し、異なるコンポーネント間の通信を容易にします。
• モジュール化設計：プラグイン拡張をサポートし、必要に応じて柔軟にカスタマイズできます。
• 高性能：非同期フレームワークに基づいており、大規模なリクエストを効率的に処理します。
• 組み込みツール：ドキュメント処理、データ分析などの一般的な機能が統合されています。

プロジェクト構造

MCP フレームワークのディレクトリ構造
├── mcp/types.py          # コンテンツタイプとインターフェースを定義
├── tools/                # ツールの実装
│   ├── base_tool.py      # ツールの基底クラスを定義
│   └── specific_tool.py  # 具体的なツールの実装
└── server.py             # MCP サーバーの実装

🚀 クイックスタート

依存関係のインストール

pip install mcp[all]  # すべての依存関係をインストール
# または必要に応じてインストール:
pip install pyMuPDF python-docx pandas openpyxl httpx anyio click

サービスの起動

uv run mcp.server --transport sse --port 8000

SSE エンドポイントにアクセス: http://localhost:8000/sse

📚 ドキュメント

MCP プロトコル

MCP は、異なるコンポーネント間の相互作用のための標準化されたプロトコルを定義しています。核心的な内容は以下の通りです。

• コンテンツタイプ：

  • テキストコンテンツ (types.TextContent)
  • 画像コンテンツ (types.ImageContent)
  • 埋め込みリソース (types.EmbeddedResource)

• 通信プロトコル：

  • Server-Sent Events (SSE) を使用したリアルタイム通信
  • HTTP/HTTPS プロトコルスタックをサポート

ツール開発ガイド

新しいツールの開発

1. tools ディレクトリに新しい Python ファイルを作成します。例えば、your_tool.py です。
2. 必要な依存関係と基底クラスをインポートします。

   import mcp.types as types
   from . import BaseTool, ToolRegistry
   

3. BaseTool を継承したツールクラスを作成します。

   @ToolRegistry.register
   class YourTool(BaseTool):
       """あなたのツールの説明"""
       name = "your_tool_name"  # ツールの一意の識別子
       description = "あなたのツールの説明"  # ユーザーに表示されるツールの説明
       input_schema = {
           "type": "object",
           "required": ["param1"],  # 必須パラメータ
           "properties": {
               "param1": {
                   "type": "string",
                   "description": "パラメータ1の説明",
               },
               "param2": {
                   "type": "integer",
                   "description": "パラメータ2の説明（オプション）",
               }
           },
       }
   
   async def execute(self, arguments: dict) -> list[types.TextContent | types.ImageContent | types.EmbeddedResource]:
       """ツールのロジックを実行"""
       # パラメータの検証
       if "param1" not in arguments:
           return [types.TextContent(
               type="text",
               text="Error: Missing required parameter"
           )]
       
       # 処理ロジック
       result = self._process_arguments(arguments)
       
       return [types.TextContent(
           type="text",
           text=str(result)
       )]
   

プロジェクト構造

MCP フレームワークのディレクトリ構造
├── mcp/
│   ├── types.py          # コンテンツタイプとインターフェースを定義
│   └── server.py         # MCP サーバーの実装
└── tools/
    ├── base_tool.py      # ツールの基底クラスを定義
    └── specific_tool.py  # 具体的なツールの実装

デプロイガイド

環境要件

• オペレーティングシステム：Linux、macOS、Windows (Linux の使用が推奨されます)
• Python バージョン：3.8 以上

依存関係のインストール

pip install mcp[all]  # すべての依存関係をインストール
# または必要に応じてインストール:
pip install pyMuPDF python-docx pandas openpyxl httpx anyio click

サービスの起動

uv run mcp.server --transport sse --port 8000

SSE エンドポイントにアクセス: http://localhost:8000/sse

設定ガイド

基本設定

config.py ファイルを編集します。

from mcp.config import Config

Config.load_defaults()
# またはカスタム設定:
Config.set('debug_mode', True)

高度な設定

コマンドライン引数を使用して設定します。

uv run mcp.server --config your_config.yaml --port 8000

依存関係の管理

MCP フレームワークは以下のライブラリに依存しています。

• PyMuPDF：PDF ドキュメントの処理に使用
• python-docx：Word ドキュメントの処理に使用
• pandas：データ分析に使用
• openpyxl：Excel ファイルの操作に使用
• httpx：HTTP リクエストに使用
• anyio：非同期プログラミングに使用
• click：コマンドラインツールに使用

貢献ガイド

コードの提出

1. プロジェクトのリポジトリを Fork します。
2. 新しいブランチを作成します (git checkout -b feature/your-feature)。
3. 変更をコミットします (git add .; git commit -m "your commit message")。
4. リモートリポジトリに Push します。
5. Pull Request を作成します。

開発規約

• PEP8 コードスタイルガイドに従います。
• 詳細なドキュメントを提供します。
• 単体テストケースを含めます。
• コードが CI/CD テストに合格することを確認します。

📄 ライセンス

MCP フレームワークは MIT License に準拠しており、詳細な条項は LICENSE ファイルを参照してください。

連絡先

• GitHub：mcp-framework
• メーリングリスト：dev@mcpframework.org
• 中国語コミュニティ：mcp-discuss-cn