Read a TestRail test case by id. Returns the full case detail: title, refs, steps, custom fields, labels (if TestRail 7.5+). Read-only — safe to call without user confirmation.
| Name | Required | Description | Default |
|---|---|---|---|
| caseId | Yes | TestRail case id (the C-number, e.g. 14344) |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the safety burden itself. It explicitly says 'Read-only' and 'safe to call without user confirmation,' and notes the version-dependent labels field. It does not cover error cases or authentication, but for a simple single-record get this is sufficient.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three compact sentences with no redundancy: action, return contents, and safety note are each front-loaded and purposeful. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a one-parameter read tool with a fully documented schema, the description is complete. It enumerates the key return fields, flags the TestRail version dependency, and states the safety profile in the absence of annotations.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, and the caseId parameter description already explains the ID format with an example. The tool description adds no new parameter semantics beyond restating the by-id usage, so the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Begins with a specific verb and resource: 'Read a TestRail test case by id.' It also states what is returned (full case detail), which separates it from the list/search sibling tools that return collections or subsets.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description makes applicability clear: use this when you have a specific case ID and need the full detail of a single TestRail case. It does not explicitly name alternative tools or when-not-to-use conditions, so it stops short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
