使用说明

项目简介

AutoMCP 是一个轻量级的 Model Context Protocol (MCP) 服务器实现,旨在简化 MCP 服务的部署和管理。它允许开发者通过简单的配置即可创建和运行 MCP 服务,为大型语言模型 (LLM) 应用提供上下文信息和工具调用能力。AutoMCP 支持服务分组、配置化部署、并发请求处理和输入验证,并无缝集成了 Claude 模型。

主要功能点

  • 服务分组: 支持将操作按组划分,方便管理和组织服务功能。
  • 配置化部署: 通过 YAML 或 JSON 配置文件定义服务和操作,无需编写大量代码即可部署服务。
  • 工具注册与调用: 允许将 Python 函数注册为 MCP 工具,供 LLM 客户端调用执行。
  • 数据模型验证: 使用 Pydantic 进行输入数据验证,确保请求数据的有效性。
  • 并发请求处理: 支持并发处理多个客户端请求,提高服务吞吐量。
  • 操作超时控制: 可以配置操作执行超时时间,防止服务长时间阻塞。

安装步骤

打开终端并执行以下命令安装 AutoMCP:

# 推荐使用 uv
uv pip install automcp

# 或者使用 pip
pip install automcp

服务器配置

MCP 客户端需要配置服务器的启动命令和参数才能连接到 AutoMCP 服务器。以下是一个示例 JSON 格式的配置信息,请根据您的实际环境进行调整:

{
  "server name": "math-service",  // 服务名称,可以自定义
  "command": "automcp",         // 启动服务器的命令,通常为 "automcp"
  "args": [                     // 启动参数
    "run",                      // 运行命令
    "--config",                 // 指定配置文件参数
    "service.yaml"              // 配置文件路径,请替换为您的实际配置文件路径
  ]
}

注意:

  • 'server name' 字段可以自定义,用于在 MCP 客户端中标识该服务器。
  • 'command' 字段通常设置为 'automcp',前提是 'automcp' 命令已添加到系统环境变量中。
  • 'args' 字段是一个字符串数组,包含了 'automcp run' 命令所需的参数。
  • 'service.yaml' 是服务配置文件示例,你需要根据你的实际服务配置创建或修改此文件。

基本使用方法

  1. 创建服务组和服务操作: 参考仓库 'README.md' 中的 "Quick Start" 部分,创建你的服务组 Python 文件 (例如 'my_group.py') 和服务配置文件 (例如 'service.yaml'),定义你的服务操作和配置。
  2. 配置服务: 编辑服务配置文件 'service.yaml',根据你的需求配置服务名称、描述、服务组及其配置。
  3. 启动服务器: 在终端中,使用 'automcp run --config service.yaml' 命令启动 AutoMCP 服务器。确保配置文件路径正确。
  4. 客户端调用: 使用 MCP 客户端工具(例如 Anthropic 提供的 MCP 客户端)连接到 AutoMCP 服务器。客户端需要配置服务器连接信息(如上面提供的 JSON 配置示例),并可以使用服务器提供的工具 (Operations) 。

信息

分类

开发者工具