使用说明
项目简介
Qase MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在桥接大型语言模型 (LLM) 客户端与 Qase 测试管理平台。它允许 LLM 通过标准化的 MCP 协议,调用预定义的工具来管理 Qase 平台上的测试项目、测试用例、测试套件和测试执行等资源。
主要功能点
- 项目管理: 获取Qase平台上的项目列表。
- 测试用例管理:
- 获取指定项目或测试套件下的测试用例列表。
- 创建新的测试用例,支持指定项目、标题和描述。
- 批量创建多个测试用例。
- 测试套件管理: 创建新的测试套件,支持指定项目、标题、描述、前提条件和父套件。
- 测试执行管理: 创建新的测试执行,支持指定项目、标题、描述和包含的测试用例。
安装步骤
- 安装 Node.js: 确保你的环境中已安装 Node.js v23.5.0 或更高版本。
- 获取代码: 从 GitHub 克隆或下载仓库代码。
git clone https://github.com/RayYokoyama/qase-mcp-server.git cd qase-mcp-server - 安装依赖: 在项目根目录下运行 'npm install' 安装项目依赖。
npm install - 构建项目: 运行 'npm run build' 命令编译 TypeScript 代码。
npm run build - 设置环境变量: 设置 'QASE_API_TOKEN' 环境变量为你的 Qase API 令牌。你可以在 Qase 平台的用户设置中获取 API 令牌。
服务器配置
为了让 MCP 客户端能够连接到 Qase MCP Server,需要在客户端的 MCP 配置文件(例如 'cline_mcp_settings.json')中添加以下服务器配置信息。请根据实际情况修改 'path/to/qase-mcp-server' 为你本地仓库的路径。
{ "mcpServers": { "qase": { "command": "node", "args": ["path/to/qase-mcp-server/build/index.js"], "env": { "QASE_API_TOKEN": "your-api-token" // 替换为你的 Qase API 令牌 }, "disabled": false, "autoApprove": [] } } }
- 'server name': 'qase' (服务器名称,客户端用此名称引用)
- 'command': 'node' (启动服务器的命令)
- 'args': '["path/to/qase-mcp-server/build/index.js"]' (服务器启动脚本路径,请替换为实际路径)
- 'env': 环境变量配置
- 'QASE_API_TOKEN': Qase API 令牌,请替换为你的实际令牌
- 'disabled': 'false' (启用服务器)
- 'autoApprove': '[]' (自动批准的工具列表,默认为空)
基本使用方法
配置完成后,MCP 客户端即可通过 JSON-RPC 请求调用 Qase MCP Server 提供的工具。以下是一些基本使用示例,展示了如何调用不同的工具来管理 Qase 平台上的测试资源。
获取项目列表:
{ "jsonrpc": "2.0", "id": 1, "method": "call_tool", "params": { "name": "get_projects" } }
获取指定项目的测试用例列表:
{ "jsonrpc": "2.0", "id": 2, "method": "call_tool", "params": { "name": "get_test_cases", "arguments": { "project_code": "DEMO" // 替换为你的项目代码 } } }
创建一个新的测试用例:
{ "jsonrpc": "2.0", "id": 3, "method": "call_tool", "params": { "name": "create_test_case", "arguments": { "project_code": "DEMO", // 替换为你的项目代码 "title": "新的测试用例标题", "description": "测试用例的详细描述" } } }
更多工具的使用方法和参数说明,请参考仓库 'README.md' 文件中 "利用可能なツール" 部分的详细描述。
信息
分类
开发者工具