Auto MCP

🚀 自動MCP使用ドキュメント

自動MCPは、様々なエージェントフレームワークをサポートし、自動化されたMCPサービスを提供するツールです。このドキュメントでは、自動MCPのインストール、基本的な使用方法、アダプター開発などについて説明します。

🚀 クイックスタート

自動MCPをすぐに使い始めるには、以下の手順に従ってください。

📦 インストール

pipを使用して自動MCPをインストールすることができます。

pip install automcp

💻 使用例

基本的な使用法

自動スクリプトでの実行

ターミナルで以下のコマンドを入力して実行します。

automcp run path/to/your-agent.py

Pythonコードでの実行

Pythonスクリプトでインポートして使用します。

from automcp import AutoMCP

# AutoMCPインスタンスを初期化し、エージェントファイルのパスと設定を指定する
auto_mcp = AutoMCP(
    agent_path="path/to/your-agent.py",
    config={
        "some": "configuration"
    }
)

# AutoMCPサービスを起動する
auto_mcp.start()

コマンドラインツールの使用

以下のコマンドを実行してヘルプ情報を表示します。

automcp --help

高度な使用法

アダプター開発

新しいエージェントフレームワークのサポートを作成するには、以下の手順に従ってください。

1. automcp/adapters/ ディレクトリに新しいアダプターファイルを作成するか、既存のフレームワークファイルに追加します。
2. 以下のパラメータを受け取るアダプター関数を実装します。
   • エージェントインスタンス
   • 名前
   • 説明
   • 入力モード
3. アダプターを AutoMCP クラスの _ADAPTERS 辞書に登録し、対応するフレームワーククラスを指定します。

設定ファイルの形式

プロジェクトのルートディレクトリに mcp.json ファイルを作成し、以下の設定を追加します。

{
    "servers": {
        "your-server-name": {
            "type": "stdio",
            "command": "/path/to/agent/script",
            "args": [],
            "env": {}
        }
    }
}

サポートされているフレームワーク

現在サポートされているエージェントフレームワークは以下の通りです。

• Framework A

  • 特徴：複雑なタスクを効率的に処理します。
  • サンプルコード：

    from automcp.adapters.framework_a import create_framework_a_adapter
    
    adapter = create_framework_a_adapter(
        instance=your_instance,
        name="Your Agent",
        description="This is a sample agent.",
        input_schema=InputSchema
    )
    

• Framework B

  • 特徴：データ処理タスクに適しています。
  • サンプルコード：

    from automcp.adapters.framework_b import create_framework_b_adapter
    
    adapter = create_framework_b_adapter(
        instance=your_instance,
        name="Your Agent",
        description="This is a sample agent.",
        input_schema=InputSchema
    )
    

コマンドラインでのエージェント起動

以下のコマンドを使用してエージェントサービスを起動します。

automcp serve --config path/to/mcp.json

IDEへの統合

Cursor IDEでは、.cursor フォルダ内の mcp.json を設定し、以下の内容を追加します。

{
    "servers": {
        "your-server-name": {
            "type": "stdio",
            "command": "/path/to/venv/bin/python",
            "args": ["path/to/run_mcp.py"],
            "env": {
                "OPENAI_API_KEY": "your-key"
            }
        }
    }
}

新しいアダプターの作成

新しいエージェントフレームワークのサポートを追加するには、以下の手順に従ってください。

1. automcp/adapters/ ディレクトリに新しいアダプターファイルを作成するか、既存のフレームワークファイルに追加します。
2. 以下のようにアダプター関数を実装します。

def create_new_adapter(agent_instance, name, description, input_schema):
    # 具体的な適応ロジックを実装する
    pass

3. 新しいアダプターを AutoMCP クラスの _ADAPTERS 辞書に登録し、対応するフレームワーククラスを指定します。

🔧 注意事項

• アダプターを作成する際には、すべての可能性のある例外やエラー状況を処理するようにしてください。
• コードをシンプルで理解しやすく保ち、Pythonのベストプラクティスに従ってください。
• 新しいアダプターの機能と互換性を定期的にテストしてください。

📚 ドキュメント

基本設定の例

from automcp import AutoMCP

# AutoMCPインスタンスを初期化する
auto_mcp = AutoMCP(
    agent_path="path/to/your-agent.py",
    config={
        "enable_feature": True,
        "log_level": "debug"
    }
)

# サービスを起動する
auto_mcp.start()

アダプターの例

from automcp.adapters.base import BaseAdapter

class NewFrameworkAdapter(BaseAdapter):
    def __init__(self, instance, name, description, input_schema):
        super().__init__(instance, name, description, input_schema)
    
    def _process_request(self, request):
        # 具体的なリクエスト処理ロジックを実装する
        pass

ドキュメントの参照

• 公式ドキュメント
• GitHubリポジトリ

以上のガイドに従うことで、自動MCPフレームワークを簡単に使用し、様々なエージェントの要件をサポートするように拡張することができます。何か問題や提案があれば、ドキュメントを参照するか、サポートチームに連絡してください。