Skip to main content
Glama

Yardstick ATS

Preview an unsaved workflow rule (runs nothing)

yardstick_automation_rules_preview_draft
Read-onlyIdempotent

Preview a rule before saving it, for a real application: the same result as preview-rule. Pass the rule as you would to create (CLI: --body-json '{"rule":{...}}'); add rule_id to preview unsaved edits to that rule. Saves nothing and executes no action.

Input Schema

NameRequiredDescriptionDefault
ruleYesThe rule as you would pass it to create.
rule_idNo
request_idNo
application_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint: false, and openWorldHint: false. The description reinforces that it saves nothing and executes no action, which is useful, but it adds little about preconditions, error behavior, or what the preview 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?

Three compact sentences, front-loaded with purpose, then invocation detail, then the no-side-effects guarantee. The CLI example earns its place and there is no filler.

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?

For a tool with a deeply nested rule schema, no output schema, and only 25% schema description coverage, the definition is thin. It omits what the preview returns, how application_id is used beyond the vague 'real application' phrase, request_id semantics, and validation/error behavior.

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?

Schema description coverage is only 25%, so the description needs to compensate. It explains the main rule parameter as create-style input with a CLI example and explains conditional rule_id, but application_id is only weakly implied by 'for a real application' and request_id is never explained.

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 names a specific verb (Preview) and resource (an unsaved workflow rule) and scopes it to a real application. It clearly distinguishes previewing from saving, but the reference to 'preview-rule' does not explain how this tool differs from that sibling.

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?

It gives a clear before-saving context and explains when to add rule_id for unsaved edits. However, it does not say when to choose this over yardstick_automation_rules_preview or yardstick_automation_rules_preview_rule; saying it gives the 'same result as preview-rule' muddies selection rather than routing.

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.