使用说明

项目简介

AutoMCP 是一个 Python 库，它实现了一个轻量级、可配置的 Model Context Protocol (MCP) 服务器。它旨在简化 MCP 服务器的部署和管理，支持通过配置文件轻松创建和扩展服务组，并无缝集成 Claude 等 LLM 模型。AutoMCP 专注于提供一个易于使用、高性能且可扩展的上下文服务框架，用于支持各种 LLM 应用场景。

主要功能点

服务组管理: 支持创建和管理服务组，允许按功能模块组织和管理操作 (Tools)。
配置驱动: 完全基于配置进行部署，简化服务器的配置和启动过程。
单/多组服务: 支持部署包含单个或多个服务组的 MCP 服务器。
Claude 集成: 特别优化了与 Claude 模型的集成，方便构建基于 Claude 的应用。
并发处理: 能够处理并发请求，保证服务器在高负载下的稳定性和响应速度。
输入验证: 对所有输入请求进行强类型校验，确保数据安全和操作的可靠性。

安装步骤

安装 AutoMCP 库: 打开终端，根据您的 Python 环境选择以下命令安装 AutoMCP：

# 推荐使用 uv (更快更高效)
uv pip install automcp

# 或者使用 pip
pip install automcp

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令 (command) 及其参数 (args) 才能连接 AutoMCP 服务器。以下是一个示例配置信息（JSON 格式）：

{
  "serverName": "automcp-server",
  "command": "automcp",
  "args": [
    "run",
    "--config",
    "service.yaml"
  ],
  "description": "AutoMCP 服务器配置",
  "parameters": {
    "configFilePath": "service.yaml",
    "timeout": 30
  },
  "notes": "请确保 service.yaml 配置文件与启动命令在同一目录下，或使用绝对路径指定配置文件位置。\n timeout 参数为操作超时时间，单位为秒。"
}

参数注释:

'serverName': MCP 服务器的名称，客户端用于标识连接的服务。
'command': 启动 MCP 服务器的命令，这里是 'automcp' (AutoMCP 命令行工具)。
'args': 传递给 'automcp' 命令的参数列表：
- '"run"': 指定 'automcp' 命令执行 'run' 子命令，用于启动服务器。
- '"--config"': 指定配置文件的参数。
- '"service.yaml"': 配置文件的名称，AutoMCP 服务器将根据此文件加载服务组和操作。
'description': 对该服务器配置的简要描述，方便客户端用户理解。
'parameters': 额外的参数配置，可以包含：
- 'configFilePath': 服务配置文件的路径，默认为 'service.yaml'。
- 'timeout': 操作超时时间，单位为秒，默认为 '30' 秒。
'notes': 配置的注意事项，例如配置文件路径和参数说明。

service.yaml 示例 (服务配置文件):

name: math-service
description: Mathematical operations

groups:
  "my_group:MathGroup": # 模块路径:服务组类名
    name: math-ops
    description: Basic math operations
    config:
      precision: 4

请根据实际的服务组 Python 文件路径和服务组类名修改 'groups' 下的配置。

基本使用方法

创建服务组: 定义包含操作 (Tools) 的 Python 类，并使用 '@operation' 装饰器标记操作函数。参考 'Quick Start' 中的 'my_group.py' 示例。
编写配置文件: 创建 'service.yaml' (或 JSON 格式的 group.json) 配置文件，描述服务和组的配置信息，包括服务名称、描述、包含的服务组及其配置。
启动服务器: 在终端中使用 'automcp run --config service.yaml' 命令启动 AutoMCP 服务器。
客户端连接和调用: MCP 客户端根据上述 服务器配置 中的信息连接到 AutoMCP 服务器，并调用已注册的操作 (Tools)。

请参考仓库中的 'README.md' 和 'examples' 目录获取更详细的配置和使用方法。

关键词