Automcp

🚀 自動創建代理適配器指南

本指南將指導你如何使用AutomCP創建新的代理適配器，並將其集成到MCP客戶端中，幫助你更高效地進行代理框架適配工作。

🚀 快速開始

要開始使用AutomCP，請按照以下步驟進行安裝：

📦 安裝指南

1. 通過pip安裝：

pip install automcp

2. 通過GitHub克隆並運行：

git clone https://github.com/your-repository/automcp.git
cd automcp && python -m pip install .

3. 創建新的代理適配器： 使用以下命令生成新的適配器文件：

automcp init new_adapter

💻 使用示例

基本用法

創建新的代理適配器

步驟1：在automcp/adapters/目錄下新建一個Python文件，例如framework.py。 步驟2：按照以下代碼模板編寫你的適配器：

# automcp/adapters/framework.py
import json
import contextlib
import io
from typing import Any, Callable, Type
from pydantic import BaseModel

def create_framework_adapter(
    agent_instance: Any,
    name: str,
    description: str,
    input_schema: Type[BaseModel],
) -> Callable:
    """創建一個與指定框架兼容的代理適配器"""

    # 獲取輸入模式中的字段名稱及其類型
    schema_fields = input_schema.model_fields

    # 生成函數參數字符串
    params_str = ", ".join(
        f"{field_name}: {field_info.annotation.__name__}"
        for field_name, field_info in schema_fields.items()
    )

    # 生成函數體，用於構造輸入模式並調用代理框架的方法
    body_str = f"""def run_agent({params_str}):
        inputs = input_schema({', '.join(f'{name}={name}' for name in schema_fields)})
        with contextlib.redirect_stdout(io.StringIO()):
            result = agent_instance.framework_specific_run(inputs=inputs.model_dump())
        return result.framework_specific_result()
    """

    # 創建命名空間以執行動態代碼
    namespace = {
        "input_schema": input_schema,
        "agent_instance": agent_instance,
        "json": json,
        "contextlib": contextlib,
        "io": io,
    }

    # 執行函數定義並獲取生成的函數
    exec(body_str, namespace)
    run_agent = namespace["run_agent"]

    # 設置函數的元數據
    run_agent.__name__ = name
    run_agent.__doc__ = description

    return run_agent

高級用法

示例實現

假設我們正在為一個名為AwesomeFramework的新代理框架創建適配器，代碼如下：

# automcp/adapters/awesome_framework.py
from .base import AgentAdapter

class AwesomeFrameworkAdapter(AgentAdapter):
    def __init__(self, agent_instance, name, description, input_schema):
        super().__init__(agent_instance, name, description, input_schema)
        
    def create_adapter(self):
        return self.create_framework_adapter()
    
    @staticmethod
    def create_framework_adapter():
        # 在此處實現具體的適配器邏輯
        pass

與MCP客戶端集成

步驟1：在項目根目錄下創建一個.cursor文件夾。 步驟2：在.cursor文件夾中添加一個mcp.json文件，內容如下：

{
    "mcpServers": {
        "my-awesome-adapter": {
            "type": "custom",
            "module": "awesome_framework_adapter",
            "class": "AwesomeFrameworkAdapter",
            "init": {
                "agent_instance": "path.to.your.agent.instance",
                "name": "Awesome Framework Adapter",
                "description": "A powerful framework for NLP tasks.",
                "input_schema": "path.to.input.schema.Model"
            }
        }
    }
}

⚠️ 重要提示

1. 路徑規範：確保所有模塊和類的路徑正確無誤。
2. 依賴管理：在使用前確保安裝了所有必要的依賴項。
3. 錯誤處理：在生產環境中建議添加適當的異常捕獲機制。

通過以上步驟，你可以輕鬆地為新的代理框架創建適配器，並將其集成到各種MCP客戶端中。