使用说明
TestRail MCP服务器
这是什么?
该工具将您的TestRail测试管理系统与Cursor或Claude Desktop等AI助手连接起来。它允许您的AI助手读取和更新测试用例,添加测试结果,并通过简单的对话管理您的测试工作流程。
特性
- 查看测试用例:显示测试用例、项目和测试运行
- 更新测试:修改测试用例详细信息、标题和描述
- 添加结果:记录测试结果并上传截图
- 搜索和筛选:快速找到特定的测试或项目
- 文件附件:将文档和图像上传到测试用例
- 完全集成:适用于Cursor、Claude Desktop和其他AI工具
这是给谁的?
- QA工程师 谁想通过人工智能对话来管理测试
- 项目经理 需要快速访问测试信息的人员
- 开发者 谁想将测试集成到他们的人工智能辅助工作流程中
- 任何人 谁使用TestRail,并希望通过人工智能使其更易于访问
快速开始
- 安装Node.js 从 nodejs.org
- 获取TestRail API密钥 从您的TestRail设置
- 安装服务器:
npm install -g testrail-mcp-server - 配置您的AI助手 使用您的TestRail凭据
- 重启你的AI助手 开始提问吧!
先决条件
安装前需要这些工具:
- Node.js 18.17.0+ -下载自 nodejs.org (LTS版本)
- npm -自动附带Node.js
- AI助手 -光标(cursor.sh)或克劳德桌面(克劳德·艾)
- TestRail帐户 -启用API访问
验证安装:
node --version # Should show 18.17.0 or higher
npm --version # Should show a version number
获取TestRail API凭据
-
登录TestRail 在您的实例URL(例如。,
https://yourcompany.testrail.com) -
获取API密钥:
- 点击您的个人资料图片→ “我的设置”
- 滚动至“API密钥”部分
- 单击“添加API密钥”
- 命名它(例如,“MCP服务器”)
- 安全复制并保存API密钥
-
记下您的凭据:
- 用户名:您的TestRail登录(通常是电子邮件)
- 统一资源定位符:您的TestRail网址
安装
步骤1:安装服务器
打开命令提示符/终端并运行:
npm install -g testrail-mcp-server
步骤2:配置您的AI助手
对于游标用户:
- 打开的游标→ 设置(
Ctrl + ,或Cmd + ,) - 查找“MCP”设置
- 添加此配置:
{
"mcpServers": {
"testrail": {
"command": "npx",
"args": ["testrail-mcp-server"],
"env": {
"TESTRAIL_USERNAME": "your_testrail_username",
"TESTRAIL_API_KEY": "your_testrail_api_key",
"TESTRAIL_URL": "https://your-instance.testrail.com"
}
}
}
}
对于Claude桌面用户:
- 查找配置文件:
- 窗户:
%APPDATA%\Claude\claude_desktop_config.json - 雨衣:
~/Library/Application Support/Claude/claude_desktop_config.json
- 窗户:
- 添加与上述相同的配置
替换这些值:
your_testrail_username:您的TestRail登录(通常是电子邮件)your_testrail_api_key:来自TestRail的API密钥https://your-instance.testrail.com:您的TestRail URL
步骤3:重新启动并测试
- 重启 你的AI助手完全
- 测试:问“你能给我看看我的TestRail项目吗?”
用法
设置完成后,只需自然地与您的AI助手交谈:
查看信息:
- “显示我的所有TestRail项目”
- “项目1中有哪些测试用例?”
- “显示测试用例编号123”
更新测试:
- “用标题‘登录功能测试’更新测试用例123”
- “将测试用例456的优先级更改为高”
- “向测试用例789添加注释”
添加结果:
- “将测试456标记为通过”
- “在测试789中添加一个失败的结果,注释为‘按钮不可点击’”
- “将此屏幕截图上传到测试用例123”
搜索:
- “查找标题中带有'login'的所有测试用例”
- “显示上次测试运行中失败的测试”
故障排除
“找不到命令”或“无法识别npm”
- 从以下位置安装Node.js nodejs.org
- 重新启动命令提示符/终端
- 与核对
node --version
“身份验证失败”或“凭据无效”
- 验证您的TestRail用户名(通常是电子邮件)
- 再次从TestRail复制API密钥
- 检查TestRail URL是否以开头
https://
“连接超时”或“无法连接到TestRail”
- 检查互联网连接
- 验证TestRail URL是否正确
- 在web浏览器中测试TestRail
AI助手不回答TestRail问题
- 完全重新启动您的AI助手
- 检查配置文件格式(有效的JSON)
- 确认所有必填字段均已填写
“权限被拒绝”错误
- 以管理员身份运行命令提示符(Windows)或使用
sudo(Mac/Linux) - 更新到最新的Node.js版本
还有问题吗?
- 检查错误消息以获取线索
- 再次尝试安装步骤
- 在以下位置创建问题 GitHub 包含您的错误详细信息
安全最佳实践
- 永远不要共享您的API密钥 -将其视为密码
- 使用HTTPS URL -确保您的TestRail URL以开头
https:// - 不要将API密钥放在代码中 -始终使用配置文件
- 定期旋转API键 -每隔几个月换一次
- 确保TestRail帐户的安全 -使用强密码和2FA
不该做什么:
- 不要与他人共享配置文件
- 不要将API密钥放在公共存储库中
- 不使用HTTP URL(仅HTTPS)
- 不要共享显示API密钥的屏幕截图
额外资源
有用链接:
获得支持:
- GitHub问题 -报告错误或提问
- 有关API访问问题,请联系TestRail管理员
许可证
MIT许可证-请参阅 许可证 文件以获取详细信息。