Skip to main content
Glama
uarlouski

TestRail MCP Server

by uarlouski

query_suite

Read-onlyIdempotent

Retrieve a single test suite or all test suites for a TestRail project. Specify action 'one' or 'many' in the payload.

Instructions

Retrieve a single test suite or all test suites for a project in TestRail. Set payload.action to 'one' or 'many' to specify the operation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
payloadYesThe payload containing the action ('one' or 'many') and corresponding parameters

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.2.0
  2. Removedv2.1.0
  3. Addedv2.0.0

TDQS

B3.4/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered. The description adds nothing beyond the schema-mandated action switch — no pagination, auth, or result-shape context.

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?

Two sentences, zero waste, with the core purpose front-loaded before the parameter hint. Nothing is padded or repeated.

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?

For a simple read-only retrieval tool with 100% schema coverage and annotations carrying the safety profile, the description is largely sufficient. The only gap is the absence of an output schema paired with no mention of what the retrieval returns.

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?

Schema description coverage is 100%, including per-branch docs for action, suite_id and project_id, so the schema does the heavy lifting. The description restates the 'one'/'many' mechanism without adding syntax or constraint detail, so the baseline 3 applies.

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

Purpose4/5

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

States a specific verb ('Retrieve') and resource ('test suite'/'test suites') in TestRail, and explicitly covers both the single and list modes. It distinguishes itself from 'mutate_suite' implicitly via the read verb, but never names an alternative sibling, so it stops short of a 5.

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

Usage Guidelines3/5

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

The description ties each mode to a need (one suite vs. all suites for a project), which is implied guidance. However it never states when to prefer this tool over siblings like mutate_suite or query_project, and offers no exclusions or prerequisites.

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