ROADMAP.md•3.27 kB
# TestRail MCP Server - Implementation Roadmap
## Phase 1: Core Test Case Management (Week 1)
- [x] get_case - Fetch single test case
- [x] add_case - Create new test case
- [x] update_case - Update existing test case
- [ ] delete_case - Delete test case
- [x] get_cases - Get multiple test cases with filters
## Phase 2: Test Run & Results (Week 2)
- [x] get_run - Get test run details
- [x] get_runs - Get test runs
- [x] get_tests - Get tests for a test run
- [x] get_test - Get test details
- [x] update_test - Update test labels
- [x] update_run - Update test run
- [ ] add_run - Create new test run
- [ ] close_run - Close test run
- [x] add_result - Add test result
- [ ] add_results - Add multiple test results
- [ ] get_results - Get test results
## Phase 3: Project & Suite Management (Week 3)
- [x] get_projects - List all projects
- [x] get_project - Get project details
- [x] get_suites - Get test suites
- [x] get_suite - Get suite details
- [ ] add_suite - Create test suite
- [x] get_sections - Get sections
- [ ] add_section - Create section
## Phase 4: Attachments Management (Week 4)
- [x] add_attachment_to_case - Add attachment to test case
- [ ] add_attachment_to_plan - Add attachment to test plan
- [ ] add_attachment_to_plan_entry - Add attachment to plan entry
- [ ] add_attachment_to_result - Add attachment to test result
- [ ] add_attachment_to_run - Add attachment to test run
- [ ] get_attachments_for_case - Get attachments for test case
- [ ] get_attachments_for_plan - Get attachments for test plan
- [ ] get_attachments_for_plan_entry - Get attachments for plan entry
- [ ] get_attachments_for_run - Get attachments for test run
- [ ] get_attachments_for_test - Get attachments for test
- [ ] get_attachment - Get specific attachment details
- [ ] delete_attachment - Delete attachment
## Phase 5: Advanced Features (Week 5)
- [ ] get_users - List users
- [ ] get_milestones - Get milestones
- [ ] get_case_types - Get case types
- [x] get_case_fields - Get custom fields
- [ ] search_cases - Search test cases
## Phase 6: Bulk Operations & Utilities (Week 6)
- [ ] bulk_update_cases - Update multiple cases
- [ ] bulk_add_results - Add results for multiple tests
## Tool Categories
### High Priority (Essential for basic TestRail integration)
1. Test Case CRUD operations
2. Test Run management
3. Test Results management
4. Project/Suite listing
### Medium Priority (Important for team collaboration)
1. User management
2. Section management
3. Milestone management
4. Configuration data
### Low Priority (Nice to have)
1. Bulk operations
2. Advanced search/filter
3. Utility functions
## Implementation Notes
### Error Handling
- All tools should follow the same error handling pattern as `get_case`
- Use consistent error types: auth, not_found, rate_limited, server, network
- Provide meaningful error messages
### Input Validation
- Use Zod schemas for all input validation
- Include proper descriptions for all parameters
- Handle optional vs required parameters appropriately
### Logging
- Log all tool calls with relevant parameters
- Log successful operations and errors
- Use structured logging with context
### Testing
- Unit tests for each tool
- Integration tests with TestRail API
- Error scenario testing