Skip to main content
Glama
akoehlerbbw

TestRail MCP Server

by akoehlerbbw
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

getCases

Retrieve a filtered list of test cases from a TestRail project and suite, returning basic fields for performance. Use filters like priority, type, section, or creator to narrow results, then get full case details with getCase.

Instructions

Retrieves test cases list with basic fields only (excludes steps/expected results for performance). REQUIRED: projectId, suiteId. OPTIONAL: createdBy, filter, limit (default 50), milestoneId, offset (default 0), priorityId, refs, sectionId, templateId, typeId, updatedBy, labelId. Use getCase for full details.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
refsNoA single Reference ID (e.g. TR-1, 4291, etc.) —requires TestRail 6.5.2 or later
limitNoThe number of test cases the response should return (The response size is 50 by default) —requires TestRail 6.7 or later
filterNoOnly return cases with matching filter string in the case title
offsetNoWhere to start counting the tests cases from (the offset)—requires TestRail 6.7 or later
typeIdNoA comma-separated list of case type IDs to filter by
labelIdNoA comma-separated list of label IDs to filter by
suiteIdYesTestRail Suite ID
createdByNoA comma-separated list of creators (user IDs) to filter by
projectIdYesTestRail Project ID
sectionIdNoThe ID of a test case section
updatedByNoA comma-separated list of user IDs who updated test cases to filter by
priorityIdNoA comma-separated list of priority IDs to filter by
templateIdNoA comma-separated list of template IDs to filter by —requires TestRail 5.2 or later
milestoneIdNoA comma-separated list of milestone IDs to filter by (not available if the milestone field is disabled for the project)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.19.9

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It discloses that only basic fields are returned (excluding steps/expected results) for performance reasons, which adds valuable behavioral context beyond the input schema.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences: first states purpose and key performance limitation, second lists parameters and recommendation. It is front-loaded and contains no unnecessary words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite no output schema and high parameter count (14), the description effectively communicates the core behavior (basic fields, performance reason) and directs to getCase for details. It omits pagination mechanics (limit/offset details are in schema) and error handling, but is adequate for selection and invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema coverage, baseline is 3. The description summarizes required vs optional and mentions default values (limit 50, offset 0), but does not add substantial new semantic meaning beyond what the schema already provides for each parameter.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'Retrieves test cases list' with a specific verb and resource. It distinguishes from sibling 'getCase' by noting it returns basic fields only, and from other case tools by its scope.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly lists required (projectId, suiteId) and optional parameters, and advises to 'Use getCase for full details', providing clear when-to-use guidance versus an alternative.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools