QA Sphere MCP 服务器使用说明

项目简介

QA Sphere MCP 服务器是一个基于 Model Context Protocol (MCP) 的后端应用，它作为 QA Sphere 测试管理系统和大型语言模型 (LLM) 客户端之间的桥梁。通过此服务器，LLM 可以访问 QA Sphere 中存储的测试用例、项目信息等资源，从而实现更智能的测试相关应用，例如：理解和总结测试用例、在开发流程中引用特定测试用例等。

主要功能点

获取测试用例信息 (get_test_case): 根据测试用例标识（格式为 '项目代码-用例序号'，如 'BDI-123'）从 QA Sphere 获取详细的测试用例内容，包括标题、步骤、前置条件等。
获取项目信息 (get_project): 根据项目代码（如 'BDI'）获取 QA Sphere 中项目的基本信息，例如项目名称、描述等。
列出项目列表 (list_projects): 获取当前 QA Sphere 账户下的所有项目列表。
列出测试用例 (list_test_cases): 在指定项目下，根据分页、排序、搜索、标签、文件夹等多种条件，灵活地列出测试用例。
列出测试用例文件夹 (list_test_cases_folders): 获取指定项目下的测试用例文件夹结构，方便用户组织和查找测试用例。
列出测试用例标签 (list_test_cases_tags): 获取指定项目下定义的测试用例标签列表，用于分类和筛选测试用例。

安装步骤

安装 Node.js: 确保您的计算机上已安装 Node.js (建议使用 LTS 版本)。
安装 QA Sphere MCP 服务器: 打开终端或命令提示符，运行以下命令全局安装 'qasphere-mcp'：
```
npm install -g qasphere-mcp
```
或者，您也可以将此仓库克隆到本地并使用 'npm install' 安装依赖。

服务器配置

对于支持 MCP 协议的 LLM 客户端（如 Claude、Cursor、5ire 等），您需要配置 MCP 服务器连接信息。以下是通用的 JSON 配置模板，您需要根据您的 QA Sphere 账户信息进行修改。

{
  "mcpServers": {
    "qasphere": {
      "command": "npx",
      "args": [
        "-y",
        "qasphere-mcp"
      ],
      "env": {
        "QASPHERE_TENANT_URL": "your-company.region.qasphere.com",  // 替换为您的 QA Sphere 公司 URL，例如 example.eu2.qasphere.com
        "QASPHERE_API_KEY": "your-api-key"    // 替换为您的 QA Sphere API 密钥
      }
    }
  }
}

配置参数说明:

'server name': 'qasphere' (您可以自定义服务器名称，客户端中用于标识此服务器)
'command': 'npx' (Node.js 包执行器，用于运行 'qasphere-mcp' 命令)
'args':
- '-y': 'npx' 的参数，表示自动确认安装 'qasphere-mcp' 包（如果尚未安装）。
- 'qasphere-mcp': 要执行的命令，即启动 QA Sphere MCP 服务器。
'env' (环境变量):
- 'QASPHERE_TENANT_URL': 必填。您的 QA Sphere 公司 URL。请替换 'your-company.region.qasphere.com' 为您的实际 URL。注意包含地域信息，例如 'example.eu1.qasphere.com' 或 'example.eu2.qasphere.com'。
- 'QASPHERE_API_KEY': 必填。您的 QA Sphere API 密钥。请在 QA Sphere 后台 (Settings ⚙️ → API Keys → Add API Key) 获取并替换 'your-api-key'。

客户端配置示例:

请参考仓库 README.md 文件的 "Setup Instructions" 部分，根据您使用的 MCP 客户端（如 Claude、Cursor、5ire）的指引进行配置，将上述 JSON 配置添加到客户端的 MCP 服务器设置中。

基本使用方法

配置完成后，在支持 MCP 的 LLM 客户端中，您可以像使用其他工具一样调用 QA Sphere MCP 服务器提供的功能。

例如，在 LLM 对话中，您可以指示 LLM 执行以下操作：

"使用 'get_test_case' 工具，marker 参数为 '[项目代码]-[用例序号]'，例如 'BDI-123'，来获取具体的测试用例内容。"
"使用 'get_project' 工具，projectCode 参数为 '[项目代码]'，例如 'BDI'，来获取项目信息。"
"使用 'list_test_cases' 工具，projectCode 参数为 '[项目代码]'，例如 'BDI'，来列出项目下的测试用例。"
"使用 'list_test_cases_folders' 工具，projectCode 参数为 '[项目代码]'，例如 'BDI'，来获取测试用例文件夹列表。"
"使用 'list_test_cases_tags' 工具，projectCode 参数为 '[项目代码]'，来获取测试用例标签列表。"
"使用 'list_projects' 工具，无需参数，获取所有项目列表。"

LLM 客户端会将您的指令转换为 MCP 请求发送给 QA Sphere MCP 服务器，服务器会调用 QA Sphere API 获取数据，并将结果以 MCP 响应的形式返回给 LLM 客户端，最终 LLM 客户端会将结果呈现给您。

注意: 请确保您已在 QA Sphere 后台获取有效的 API 密钥，并正确配置 'QASPHERE_TENANT_URL' 和 'QASPHERE_API_KEY' 环境变量。

关键词