Auto MCP

🚀 自動MCP 使用文檔

自動MCP是一個強大的工具，可用於支持各種代理框架，幫助開發者更高效地處理代理任務，並且易於擴展和配置。

🚀 快速開始

安裝

使用 pip 安裝：

pip install automcp

✨ 主要特性

• 支持多種代理框架，如 Framework A 和 Framework B。
• 提供多種運行方式，包括命令行、Python 代碼和命令行工具。
• 可通過適配器開發擴展對新代理框架的支持。

📦 安裝指南

使用 pip 即可輕鬆完成安裝：

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 字典中，指定對應的框架類。

🔧 技術細節

示例代碼

基本配置示例

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倉庫

⚠️ 注意事項

⚠️ 重要提示

• 在編寫適配器時，請確保處理所有可能的異常和錯誤情況。
• 保持代碼簡潔易懂，遵循Python最佳實踐。
• 定期測試新適配器的功能和兼容性。

通過遵循以上指南，您可以輕鬆地使用和擴展AutoMCP框架來支持各種代理需求。如果有任何問題或建議，請隨時查閱我們的文檔或聯繫支持團隊。