Skip to main content
Glama

Yardstick ATS

Preview a saved workflow rule (runs nothing)

yardstick_automation_rules_preview_rule
Read-onlyIdempotent

Preview a saved workflow rule for a real application: recipients, sender, rendered email, scheduling links and missing prerequisites. Executes no action.

Input Schema

NameRequiredDescriptionDefault
rule_idYes
request_idNo
application_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds useful behavioral context by specifying what the preview returns (recipients, sender, rendered email, scheduling links, missing prerequisites) and reinforcing that it executes no action.

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?

The description is a compact, front-loaded sentence followed by a short safety clause. It is appropriately sized and wastes little space, though 'Executes no action' partly repeats the title and readOnlyHint annotation.

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

Completeness3/5

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

With no output schema, the description carries the burden of explaining the return and it does list several preview outputs. However, it omits any mention of the optional request_id parameter and does not explain error behavior or prerequisite-check outcomes in detail.

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%, so the description must compensate. It loosely maps 'saved workflow rule' to rule_id and 'real application' to application_id, but it provides no semantics for the optional request_id parameter and no format or constraint details for any parameter.

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?

The description gives a specific verb (Preview) and resource (a saved workflow rule) and even lists what the preview surfaces, which is clearer than a generic read. However, it does not distinguish itself from the sibling yardstick_automation_rules_preview or yardstick_automation_rules_read, so an agent must infer the difference.

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?

The description implies a validation context by noting it is 'for a real application' and reports 'missing prerequisites', but it never states when to choose this tool over the existing preview or read siblings. There are no exclusions or explicit alternatives given.

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.