项目简介

这是一个基于 Model Context Protocol (MCP) 构建的服务器实现，专门用于与 TestRail 测试管理系统集成。它允许大型语言模型 (LLM) 客户端通过标准化的协议访问和操作 TestRail 中的各种实体，例如项目、测试用例、测试运行和测试结果等。通过这个服务器，LLM 可以理解并执行与 TestRail 相关的任务，从而提升测试管理工作的效率。

主要功能点

• 访问 TestRail 数据: 能够获取 TestRail 中的项目、测试用例、测试运行、测试结果以及数据集等信息。
• 执行 TestRail 操作: 支持在 TestRail 中创建、更新或删除项目、测试用例、测试运行和数据集，以及记录测试结果。
• 标准化 MCP 协议: 严格遵循 MCP 规范，提供一致的资源（Resource）访问和工具（Tool）调用接口。
• 客户端兼容性: 可与任何支持 MCP 协议的客户端（如 Claude Desktop, Cursor, Windsurf 等）配合使用。

安装步骤

安装该服务器需要 Python 环境。推荐使用虚拟环境。

1. 克隆仓库: 获取项目代码到本地。
2. 创建并激活虚拟环境: 在项目目录中设置一个独立的 Python 环境。
3. 安装依赖: 进入激活的虚拟环境，安装项目所需的库。

详细的命令行操作请参考项目的 README 文件。

服务器配置

为了让服务器能够连接到您的 TestRail 实例，您需要提供 TestRail API 的连接信息。这些信息通过环境变量提供给服务器。通常，您可以在运行 MCP 客户端时，在其配置中指定这些环境变量，以便它们能传递给启动的 MCP 服务器进程。

需要配置的关键环境变量包括：

• 'TESTRAIL_URL': 您的 TestRail 实例的完整 URL (例如, 'https://your-instance.testrail.io')。
• 'TESTRAIL_USERNAME': 用于登录 TestRail 的邮箱地址。
• 'TESTRAIL_API_KEY': 您的 TestRail API 密钥（不是密码）。请登录 TestRail 在 "My Settings" > "API Keys" 中生成。

在 MCP 客户端中配置此服务器时，通常需要指定启动服务器的命令 (command) 及其参数 (args)，并设置上述环境变量。例如，典型的配置会指定 'command' 为 'uvx'，'args' 为 '["testrail-mcp"]'。请查阅您使用的 MCP 客户端的文档，了解如何在其界面或配置文件中正确设置服务器启动命令和环境变量。

基本使用方法

安装并配置完成后，启动您的 MCP 客户端。客户端会自动通过 MCP 协议连接并识别此 TestRail 服务器暴露的能力（包括资源和工具）。

通过与 LLM 交互，您可以：

• 查询信息: 询问特定 TestRail 项目的状态、获取测试用例详情、查找测试运行的结果等。例如，您可以说：“查询 ID 为 123 的项目信息。”
• 执行操作: 请求 LLM 执行在 TestRail 中的操作，例如创建新的测试用例、更新测试结果、关闭测试运行等。例如，您可以说：“为 ID 为 456 的测试用例添加一个状态为通过的结果，并评论‘功能正常’。”

LLM 会根据您的问题或指令，识别并调用此服务器提供的相应工具或访问资源，然后将执行结果或获取的数据返回给您。