Skip to main content
Glama

testrail_get_fields

Retrieve custom TestRail case fields for a project or template, including names, labels, types, required status, and dropdown options. Filter to required fields only when needed.

Instructions

Custom case fields for the configured template: name, label, type, required, and dropdown options.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idNo
required_onlyNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.4/5.0
Behavior2/5

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

With no annotations, the description carries the full burden of behavioral disclosure. It hints at return content but says nothing about read-only safety, authentication, rate limits, pagination, or whether the template is resolved implicitly.

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

Conciseness4/5

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

A single compact clause with no filler; the returned fields are front-loaded. However, the fragmentary style with no verb makes it less useful than a complete sentence would be at the same length.

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

Completeness2/5

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

An output schema exists, so return values need not be explained, but the description still leaves both undocumented parameters and the tool's usage context unresolved. For a two-parameter tool with 0% schema coverage, more is needed.

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

Parameters2/5

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

Schema description coverage is 0% and neither project_id nor required_only is mentioned in the description. The phrase 'configured template' weakly implies project scoping, but the filtering behavior of required_only is entirely undocumented, so the description does not compensate for the coverage gap.

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

Purpose3/5

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

The description names the resource (custom case fields for the configured template) and enumerates the returned attributes (name, label, type, required, dropdown options), but it is a noun phrase with no verb and never states the action is a retrieval. It does not differentiate this from sibling list tools like testrail_list_cases or testrail_list_suites.

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

Usage Guidelines2/5

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

There is no guidance on when to call this tool, what a 'configured template' means, or how it relates to alternatives such as listing cases or suites. The agent must infer usage entirely from the name.

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