MCP Framework

🚀 MCP開発ガイド

このドキュメントは、MCPの開発、デプロイ、設定、ツール開発に関する詳細なガイドを提供します。

🚀 クイックスタート

このセクションでは、MCPの基本的な使い方を紹介します。まずは、ツールのテンプレートコードを見てみましょう。

💻 使用例

基本的な使用法

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

@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 argument 'param1'"
            )]
          
        # パラメータの取得
        param1 = arguments["param1"]
        param2 = arguments.get("param2", 0)  # オプションのパラメータを取得し、デフォルト値を提供する
      
        # ツールのロジックを実行する
        result = f"パラメータを処理する: {param1}, {param2}"
      
        # 結果を返す
        return [types.TextContent(
            type="text",
            text=result
        )]

📦 インストール

MCPをデプロイする方法は2つあります。Dockerを使用する方法と、従来のPythonを使用する方法です。

Dockerデプロイ（推奨）

1. 初期設定：

# リポジトリをクローンする
git clone https://github.com/your-username/mcp-framework.git
cd mcp-framework

# 環境ファイルを作成する
cp .env.example .env

2. Docker Composeを使用する：

# ビルドして起動する
docker compose up --build -d

# ログを確認する
docker compose logs -f

# コンテナを管理する
docker compose ps
docker compose pause
docker compose unpause
docker compose down

3. サービスにアクセスする：

• SSEエンドポイント: http://localhost:8000/sse

4. Cursor IDEの設定：

• 設定 → 機能 → MCPサーバーを追加する
• タイプ: "sse"
• URL: http://localhost:8000/sse

従来のPythonデプロイ

1. システム依存関係をインストールする：

# Ubuntu/Debian
sudo apt-get update
sudo apt-get install -y poppler-utils tesseract-ocr tesseract-ocr-chi-sim

# macOS
brew install poppler tesseract tesseract-lang

# Windows
# 1. Tesseractをダウンロードしてインストールする: https://github.com/UB-Mannheim/tesseract/wiki
# 2. TesseractをシステムPATHに追加する

2. Pythonの依存関係をインストールする：

# 仮想環境を作成する
python -m venv venv
source venv/bin/activate  # Linux/Mac
# または
.\venv\Scripts\activate  # Windows

# 依存関係をインストールする
pip install -r requirements.txt

3. サービスを実行する：

uvicorn mcp_server:app --reload

📚 ドキュメント

設定

環境変数

以下は、一般的に使用される環境変数です：

• MCP_HOST: サービスがバインドするホスト。デフォルトは0.0.0.0です。
• MCP_PORT: サービスがバインドするポート。デフォルトは8000です。
• MCP_DEBUG: デバッグモードを有効にするかどうか。デフォルトはFalseです。

ログ

デフォルトでは、ログはコンソールに出力されます。loggingモジュールを設定することで、ログの出力方法を変更できます。

ツール開発

ツールテンプレート

以下は、ツールの基本的なテンプレートです：

from typing import Dict, Any
import mcp.types as types
from . import BaseTool, ToolRegistry

@ToolRegistry.register
class MyTool(BaseTool):
    name = "my_tool"
    description = "これはサンプルツールです"

    async def execute(self, arguments: Dict[str, Any]) -> list[types.TextContent | types.ImageContent | types.EmbeddedResource]:
        # ここにロジックを実装する
        return []

イベント処理

イベントを購読することで、機能を拡張できます：

from .events import EventManager

class MyEventListener:
    def on_event(self, event: str, data: Dict[str, Any]):
        if event == "my_event":
            print(f"カスタムイベントを受信しました：{data}")

🔧 技術詳細

付録

よくある質問

1. サービスをデバッグするにはどうすればいいですか？

   • デバッグモードを有効にする：MCP_DEBUG=True
   • IDEのデバッグ機能を使用する

2. ログを確認するにはどうすればいいですか？

   • デフォルトではコンソールに出力されます
   • loggingモジュールを設定して、ファイルまたはデータベースに出力する

3. エラーを処理するにはどうすればいいですか？

   • ツール内で例外をキャッチし、分かりやすいエラーメッセージを返す

参考文献

• MCP公式ドキュメント
• Python型ヒント
• Uvicornドキュメント

連絡先

何か質問があれば、support@mcp.comまでご連絡ください。