使用说明
TestRail MCP 服务器
一个用于TestRail集成的完整模型上下文协议(MCP)服务器 完整API支持允许像Cursor这样的AI助手与TestRail测试管理系统进行交互。
✨ 特点/功能
📁 项目
- 获取所有项目或特定项目的详细信息
📦 测试套件
- 获取、创建和更新测试套件
📂 部分/章节
- 获取、创建、更新和删除部分
📝 测试用例
- 完整的CRUD操作(创建、读取、更新、删除)
- 获取案例类型和自定义字段
- 支持所有自定义字段和模板
🏃 试运行
- 创建、更新和关闭测试运行
- 获取运行详情和列表
🧪 测试
- 从运行中获取测试
- 详细的测试信息
✅ 结果
- 添加单个或批量测试结果
- 获取测试、用例和运行的结果
- 跟踪测试执行历史
📋 测试计划
- 获取测试计划及计划详情
🎯 里程碑
- 获取项目的里程碑
安装
npm install -g mcp-testrail
或者直接使用 npx(无需安装):
npx -y mcp-testrail
使用光标快速设置
第一步:获取您的TestRail API密钥
- 登录到您的TestRail实例
- 点击您的个人资料(右上角)
- 首选 设置 → API密钥
- 点击 添加密钥 并给它起个名字
- 复制生成的API密钥
步骤2:配置光标
- 打开光标设置 (Ctrl/Cmd + ,)
- 搜索“MCP”或前往 特点/功能 → 模型上下文协议
- 点击 编辑配置 或者打开配置文件
- 添加以下配置(也可在
cursor-config.example.json):
{
"mcpServers": {
"testrail": {
"command": "npx",
"args": ["-y", "mcp-testrail"],
"env": {
"TESTRAIL_URL": "https://your-company.testrail.io",
"TESTRAIL_USERNAME": "your-email@company.com",
"TESTRAIL_API_KEY": "your-api-key-here"
}
}
}
}
-
替换 以下数值:
https://your-company.testrail.io- 使用您的TestRail网址your-email@company.com- 使用您的TestRail邮箱your-api-key-here- 使用您在第一步中获得的API密钥
-
保存配置文件
-
重启光标
第三步:验证其工作正常
打开光标聊天并尝试:
Show me all TestRail projects
如果一切配置正确,您将看到您的TestRail项目!
环境变量
TESTRAIL_URL- 您的TestRail实例URL(例如。,https://yourcompany.testrail.io)TESTRAIL_USERNAME- 您的TestRail电子邮件地址TESTRAIL_API_KEY- 您的TestRail API密钥(在TestRail设置中生成)
🛠️ 可用工具(40+种方法)
项目
get_projects,get_project
套房
get_suites,get_suite,add_suite,update_suite
部分/章节
get_sections,get_section,add_section,update_section,delete_section
测试用例
get_cases,get_case,add_case,update_case,delete_caseget_case_types,get_case_fields
试运行
get_runs,get_run,add_run,update_run,close_run
测试
get_tests,get_test
结果
get_results,get_results_for_case,get_results_for_runadd_result,add_result_for_case,add_results_for_cases
计划
get_plans,get_plan
里程碑
get_milestones,get_milestone
许可证
麻省理工学院(MIT)
