🚀 自动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框架来支持各种代理需求。如果有任何问题或建议，请随时查阅我们的文档或联系支持团队。