Testrail skill

AI agent skill for TestRail REST API - zero dependencies, security-friendly alternative to MCP servers

Install

npx -y skills add kos322/testrail-skill

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

TestRail REST API for test management. Use when user mentions "TestRail", "test cases", "test runs", "test results", or test management operations.

SKILL.md

4.0 KB, as published. Nobody here has run it

TestRail API Skill

Direct TestRail REST API integration through repository-local bash wrappers.

Installation

Clone the repository first:

git clone https://github.com/kos322/testrail-skill.git
cd testrail-skill

Setup

Set these environment variables:

TESTRAIL_URL
TESTRAIL_USER
TESTRAIL_API_KEY

Base URL:

${TESTRAIL_URL}/index.php?/api/v2

Decision tree

Known PROJECT_ID + simple read-only question: call the direct wrapper immediately.
Unknown PROJECT_ID: call ./scripts/get_projects.sh.
Env/auth/setup problem or first-time installation: call ./scripts/doctor.sh.

Common queries

# Known project ID: total case count
./scripts/count_cases.sh PROJECT_ID [SECTION_ID] [--suite SUITE_ID]

# Known project ID: full case list with auto-pagination
./scripts/list_cases.sh PROJECT_ID [SECTION_ID] [--suite SUITE_ID]

# Known project ID: raw paginated case page
./scripts/get_cases.sh PROJECT_ID [SECTION_ID] [--suite SUITE_ID]

# Any time: read one case
./scripts/get_case.sh CASE_ID | jq -r .title

# Single field without manual JSON parsing
./scripts/get_case_field.sh CASE_ID FIELD

# Precondition shortcut
./scripts/get_case_precondition.sh CASE_ID

# Unknown project ID: discover accessible projects
./scripts/get_projects.sh | jq '(.projects // .) | map({id, name})'

# Setup/auth problem: validate env and access
./scripts/doctor.sh

Preferred wrappers

scripts/count_cases.sh — reliable total-case count
scripts/list_cases.sh — full case list with auto-pagination
scripts/get_cases.sh — raw paginated case response
scripts/get_case.sh — single case lookup
scripts/get_case_field.sh — single field lookup
scripts/get_case_precondition.sh — precondition shortcut
scripts/get_projects.sh — discover accessible projects
scripts/doctor.sh — setup/auth smoke check
scripts/create_run.sh, scripts/add_result*.sh, scripts/close_run.sh — run/result flows
scripts/get_reference_data.sh — statuses, fields, templates, users

Output contracts

Intent	Command	Output
total case count	`count-cases`	plain integer
case list	`list-cases`	plain text by default: `C{id}: {title}`
structured case list	`list-cases --format json`	JSON object with `count` and `cases`
one case	`get-case`	JSON case object
one case field	`get-case-field`	plain scalar/string or compact JSON for arrays/objects
case precondition	`get-case-precondition`	plain text / raw field value

Pagination

get_cases, get_runs, get_results*, and similar endpoints may be paginated.
Do not assume .size is a safe total unless _links.next is empty.
Use ./scripts/count_cases.sh when the question is “how many cases are there?”

Windows

Preferred: Git Bash / WSL.
PowerShell-only environment: use thin wrappers in powershell/.
PowerShell wrappers only launch bash scripts; they do not read .env themselves.

.\powershell\count-cases.ps1 1
.\powershell\list-cases.ps1 1
.\powershell\list-cases.ps1 1 --format json
.\powershell\get-case.ps1 93
.\powershell\get-case-field.ps1 2 custom_preconds
.\powershell\get-case-precondition.ps1 2
.\powershell\get-cases.ps1 1 10 --suite 1
.\powershell\get-sections.ps1 1 1
.\powershell\get-runs.ps1 1

On-demand docs

scripts/README.md — script-by-script usage
docs/api-reference.md — endpoint notes and payload shapes
docs/troubleshooting.md — setup and auth failures
docs/agent-guide.md — agent-specific execution guidance
docs/maintenance/endpoint-status.md — maintenance snapshot, not runtime guidance

Examples

examples/workflow_ci.sh
examples/workflow_plans_milestones.sh
examples/workflow_attachments.sh

Official API docs: https://support.testrail.com/hc/en-us/categories/7076541806228-API-Manual