使用说明内容（Markdown格式）

项目简介
- 该仓库实现了一个 MCP 服务器端，用于通过 JSON-RPC 与 LLM/编辑器进行交互，提供对 API 测试用例的管理、执行与结果汇总的能力，核心围绕 YAML 声明式测试用例、单元测试和测试执行工具等模块展开。
主要功能点
- MCP 服务器核心能力：按照 MCP 协议暴露工具、资源与 Prompts 的注册、执行与查询接口，支持通过标准化的 RPC 调用向客户端提供能力声明与上下文信息。
- 工具注册与执行：提供健康检查、测试用例管理（list/get/write/delete）、单元测试工具、测试执行工具等工具集，允许 LLM 客户端发起调用来管理与执行测试。
- 测试用例与执行：支持 YAML 声明的集成测试用例与单元测试用例的生成、读取、执行与结果汇总，包含对 Jest/Allure 等报告的整合能力（Allure/pytest-html）。
- 测试数据与变量解析：集成变量解析、内置工具函数、以及测试用例步骤的参数化与断言机制，提升 AI 生成测试用例的可控性与可重复性。
- 服务器与编辑器集成：通过 MCP Server 与 Claude Cursor 等编辑器进行深度集成，能够自动注册工具并通过 UI/LLM 场景触发测试流程。
- 运行与历史记录：执行结果可保存历史，提供历史查询接口，辅助追踪测试趋势。
安装步骤
- 安装运行环境
  - 需要 Python 3.10+ 环境以及 MCP 运行依赖。
- 获取 MCP 服务器
  - 使用 uv 安装并部署本 MCP 服务器仓库中的实现（快速开始示例在 README 中给出）。
- 启动 MCP 服务器
  - 通过 uv 运行工具启动本 MCP 服务器实现，默认以 stdio 的 MCP 传输模式对外提供服务。
- 编辑器/LLM 集成
  - 在编辑器中按照 MCP 客户端配置要求，注册一个 MCP 服务器：
    - 服务器名称为 api-auto-test-mcp
    - 启动命令为 api-auto-test-mcp
    - 启动参数包含工作区信息（如 --workspace ${workspace}，供不同工作区使用）
- 依赖与兼容
  - 服务器侧实现引用了 atf 框架中的模块（如 mcp.models、executor、tests、utils 等），确保依赖在运行环境中可用。
服务器配置（MCP 客户端不需要，客户的 MCP 配置需包含启动信息）服务器配置示例（JSON，供 MCP 客户端使用的字段说明） { "server_name": "api-auto-test-mcp", "command": "api-auto-test-mcp", "args": ["--workspace", "${workspace}"] }

说明
- server_name：MCP 客户端用来标识该 MCP 服务器的名称，便于在编辑器中选择与管理。
- command：启动 MCP 服务器的实际命令名称，与你在 uv 安装时的入口一致。
- args：启动参数，包含工作区路径的占位符，编辑器在实际连接时会替换为具体工作区路径。
基本使用方法
- 启动与连接
  - 通过工具链（如 uv）启动 api-auto-test-mcp 服务器，并确保工作区参数正确传入。
  - 在编辑器（Claude/Cursor 等）中将该 MCP 服务器配置为连接的后端服务。
- 使用方式
  - 调用 health_check 进行健康自测，获取服务器版本、基础路径等信息。
  - 使用 list_testcases/get_testcase/write_testcase/delete_testcase 等工具管理 YAML 测试用例。
  - 使用 run_tests 执行单个测试用例或批量执行，获取执行结果及历史。
- 结果处理
  - 执行完成后，框架会按照内置方式生成报告并可通过通知通道（如钉钉）发送摘要。
注意事项
- MCP 客户端需要正确配置服务器启动命令和工作区路径，以确保能够访问服务能力。
- 执行依赖与环境要符合测试需要（如 MySQL、SSE、Allure 等依赖要安装或可用）。
- 如需深入定制工具，可通过 MCP 提供的注册接口扩展更多功能。
链接与资源
- 代码实现覆盖 MCP 服务端核心逻辑、工具注册、测试用例生成与执行等模块。

关键词 API 自动化测试, YAML 测试用例, 测试执行工具, 单元测试生成, Allure 报告

分类ID 5

关键词

信息