Skip to main content
Glama
uarlouski

TestRail MCP Server

by uarlouski

get_configurations

Read-onlyIdempotent

Retrieve all configuration groups and configurations for a TestRail project to use in test case and test run setup.

Instructions

Get all configuration groups and configurations for a project in TestRail.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYesThe ID of the project

Schema Changelog

Changes observed during successful MCP inspections.

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

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered by structured data. The description adds only that the result is scoped to a single project and includes both groups and their configurations; it says nothing about ordering, pagination, or what happens if the project has no configurations. With annotations carrying the behavioral burden, a 3 is appropriate.

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?

One sentence, zero filler, with the resource and scope front-loaded. Nothing could be removed without losing information.

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 low-complexity, single-required-parameter read tool with a full schema and no output schema, the description covers what is needed to call it correctly. The one modest gap is that it does not sketch the shape of the returned data (groups each containing configurations), which would help an agent plan the follow-up call.

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?

The schema has a single parameter with 100% description coverage ('The ID of the project'), so the schema does the heavy lifting. The description reinforces the project scoping but adds no syntax, format, or lookup guidance beyond it. Baseline 3 for a fully documented single-parameter schema.

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-and-resource pair: 'Get all configuration groups and configurations for a project.' It also names the scope (project) and the system (TestRail), which cleanly separates it from metadata siblings like get_priorities, get_statuses, and get_templates. It stops short of explicitly distinguishing itself from any specific alternative, which keeps it at 4 rather than 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?

There is no explicit when-to-use or when-not-to-use statement, but the purpose is transparent enough that usage is implied: call it when you need the configuration groups available in a project. Given the sibling set is a group of orthogonal read-only lookups, no routing guidance is strictly needed, so this is minimum-viable rather than deficient.

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