Skip to main content
Glama
g-tiwari

@g-tiwari/mcp-testrail

by g-tiwari

get_suite

Retrieve a specific test suite from TestRail by providing its suite ID. Use this to access suite details for review or further processing.

Instructions

Get a test suite by ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
suite_idYesSuite ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.8/5.0
Behavior3/5

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

With no annotations, the description carries the burden of behavioral disclosure. 'Get' communicates a read-only fetch and no destructive side effects, but it does not describe response shape, missing-ID behavior, or access requirements. This is adequate for a simple getter but not rich.

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?

A single, front-loaded sentence with no filler. Every word earns its place, and the key scoping detail ('by ID') appears early.

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 one-parameter getter with no nested objects or enums, this description, together with the schema, supplies enough to select and invoke the tool. It could optionally mention what the response contains since no output schema exists, but the resource name makes that largely predictable.

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% and the sole parameter is already described as 'Suite ID'. The description's 'by ID' phrase mirrors the schema and adds no additional meaning, so the baseline of 3 applies.

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 uses a specific verb ('Get') and resource ('test suite') and scopes the operation to a single entity by ID. It naturally contrasts with sibling get_suites (plural), which implies the list version, so an agent can tell them apart without opening schemas.

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 phrase 'by ID' implies the tool is used when a specific suite_id is known, but it gives no explicit guidance on when to prefer get_suites or other getters. Usage context is inferred rather than stated.

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