使用说明
Allure TestOps MCP
Allure TestOps的生产就绪MCP服务器专注于测试用例、发布、测试结果和测试计划。
特性
- 来自用户API令牌的JWT承载身份验证交换,具有内存缓存和到期刷新功能。
- 项目感知工具,可选默认项目通过
ALLURE_PROJECT_ID. - 项目决议
projectId或projectName用于项目范围的操作。 - 测试用例自定义字段支持,包括查找和更新。
stdio本地MCP客户端的传输(npx或本地建造)。
工具覆盖范围
- 测试用例:列表、搜索、获取、创建、更新、删除、还原、概述、历史、场景、标签、问题、自定义字段
- 启动:列表、搜索、获取、创建、更新、删除、关闭、重新打开、统计、进度、添加测试用例/计划
- 测试结果:列表、搜索、获取、创建、更新、历史记录、分配、解析
- 测试计划:列表、获取、创建、更新、删除、运行
用户使用文档
以用户为中心的运行时和集成文档位于 docs/usages/:
docs/usages/README.mddocs/usages/docker.mddocs/usages/npx.mddocs/usages/running-locally.mddocs/usages/integrations.mddocs/usages/examples/README.mddocs/usages/examples/test-cases.mddocs/usages/examples/launches.mddocs/usages/examples/test-results.mddocs/usages/examples/test-plans.mddocs/usages/examples/custom-fields.mddocs/usages/examples/workflows.md
工具目录(GitHub页面)
自动生成的MCP工具目录通过GitHub Pages发布:
- https://armanayvazyan.github.io/allure-testops-mcp/
页面内容由源工具定义生成。当添加新工具时 src/tools/*.ts,页面工作流重新生成 docs/tools.json 并自动更新网站。
认证
此服务器遵循诱惑测试操作API指南:
- 在中使用用户生成的API令牌
ALLURE_TOKEN. - 服务器在以下位置进行交换
/api/uaa/oauth/token. - 接收到的承载JWT被缓存并重复使用,直到接近到期。
参考:https://docs.qameta.io/allure-testops/advanced/api/
环境变量
ALLURE_TESTOPS_URL=https://allure-testops.instance.com/
ALLURE_TOKEN=your-api-token
# Optional default project:
# ALLURE_PROJECT_ID=37
ALLURE_TESTOPS_URL必需的ALLURE_TOKEN必需的ALLURE_PROJECT_ID可选的
如果 ALLURE_PROJECT_ID 如果未设置,则需要项目范围的工具必须接收:
projectId,或projectName(通过解决/api/project/suggest)
在本地运行
先决条件
- Node.js v18+和npm
一步一步
- 克隆存储库:
git clone https://github.com/armanayvazyan/allure-testops-mcp.git
cd allure-testops-mcp
- 安装依赖项:
此服务器遵循诱惑测试操作API指南:
- 在中使用用户生成的API令牌
ALLURE_TOKEN. - 服务器在以下位置进行交换
/api/uaa/oauth/token. - 接收到的承载JWT被缓存并重复使用,直到接近到期。
参考:https://docs.qameta.io/allure-testops/advanced/api/
- 根据示例创建本地环境文件并填写所需值:
cp .env.example .env
设置:
ALLURE_TESTOPS_URL(必填)ALLURE_TOKEN(必填)ALLURE_PROJECT_ID(可选默认项目)
- 构建项目:
npm run build
- 从编译的输出启动MCP服务器:
npm start
- 可选:在开发模式下运行(TypeScript通过
tsx):
npm run dev
- 可选:运行集成烟雾检查:
npm run test:integration
MCP客户端设置
使用以下服务器命令之一:
- 本地构建:
command:nodeargs:["/absolute/path/to/allure-testops-mcp/dist/index.js"]
npx(GitHub规范):command:npxargs:["-y", "github:armanayvazyan/allure-testops-mcp#v1.0.0"]
npx(npm包,发布时):command:npxargs:["-y", "allure-testops-mcp@1.0.0"]
- GitHub版本固定使用
#带有标签/提交(例如#v1.0.0). 通用配置块:
{
"mcpServers": {
"allure-testops": {
"command": "npx",
"args": ["-y", "github:armanayvazyan/allure-testops-mcp#v1.0.0"],
"env": {
"ALLURE_TESTOPS_URL": "https://allure-testops.instance.com",
"ALLURE_TOKEN": "your-api-token",
"ALLURE_PROJECT_ID": "37"
}
}
}
}
克劳德桌面版
- 打开Claude Desktop MCP设置并添加
mcpServers上面的JSON条目。 - 保存配置后重新启动Claude Desktop。
克劳德代码
- 添加相同内容
mcpServers在Claude Code MCP配置中输入。 - 重新启动Claude Code会话以加载服务器。
光标
- 打开光标MCP设置并添加相同的设置
mcpServers进入。 - 保存后重新启动Cursor(或重新加载MCP服务器)。
其他MCP客户端
任何支持以下功能的MCP客户端 stdio 服务器可以使用相同的命令/env配置来使用此项目。
CI和质量门
此存储库包括推送代码和拉取请求的GitHub Actions检查:
- 编译(
npm run build) - 棉绒(
npm run lint)
CI工作流程: .github/workflows/ci.yml
审核和合并策略
存储库使用代码所有权 @armanayvazyan:
.github/CODEOWNERS.github/workflows/auto-review-request.yml自动请求@armanayvazyan关于新的PR
要在合并前要求批准,请使用以下命令在默认分支上启用分支保护:
- 合并前需要拉取请求
- 需要批准
- 需要代码所有者的审查
- 要求通过状态检查(
CI / checks)
OSS自动化
包括典型开源维护的自动化:
- Dependabot更新:
.github/dependabot.yml - 陈旧性问题/PR分诊:
.github/workflows/stale.yml - 发布说明起草:
.github/workflows/release-drafter.yml
集成烟雾测试
ALLURE_TESTOPS_URL="https://allure-testops.instance.com/" \
ALLURE_TOKEN="your-api-token" \
ALLURE_PROJECT_ID="37" \
npm run test:integration