Skip to main content
Glama

Yardstick ATS

Read a stage automation rule

yardstick_automation_rules_read
Read-onlyIdempotent

Read one stage automation rule by public id (its trigger, typed action, target stage, and is_active state).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rule_idYes
request_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already establish read-only, idempotent, non-destructive behavior. The description adds useful detail by listing what the response contains (trigger, typed action, target stage, is_active state), which helps the agent understand what this read operation returns.

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?

The description is one concise sentence, front-loads the action and key identifier, and includes a compact parenthetical listing of returned fields. No redundant or filler text is present.

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 operation with no output schema, the description adequately states what is returned and how the rule is identified. The only notable omission is the optional request_id parameter, which is not necessary for a successful basic 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 description clarifies that rule_id is a public ID, adding meaning to the bare schema field. However, the optional request_id parameter is not mentioned anywhere, and schema description coverage is 0%, leaving that parameter unexplained.

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 clearly states the operation: 'Read one stage automation rule by public id' and enumerates the specific fields returned. It distinguishes this read tool from list/create/update/delete siblings by emphasizing singular retrieval by ID.

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

Usage Guidelines4/5

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

The description makes the usage context clear: use this tool when you need a single automation rule by public ID. It does not explicitly name alternatives or state when not to use it, but the singular 'Read one' plus the tool name provide adequate differentiation from list-based alternatives.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.