Read a stage automation rule
yardstick_automation_rules_readRead one automation rule by public id (its trigger, typed action, target stage, and is_active state).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rule_id | Yes | ||
| request_id | No |
yardstick_automation_rules_readRead one automation rule by public id (its trigger, typed action, target stage, and is_active state).
| Name | Required | Description | Default |
|---|---|---|---|
| rule_id | Yes | ||
| request_id | No |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, so the description needn't restate the safety profile. It adds value by naming the fields returned (trigger, typed action, target stage, is_active), but says nothing about what happens on an unknown id or authorization requirements.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
One tight sentence that front-loads the verb, resource, key parameter, and return shape with zero filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple read tool with full read-only annotations and no output schema, the description is largely adequate, but the missing request_id semantics and error behavior leave gaps in a 0%-coverage schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description should compensate for two undocumented parameters. It identifies rule_id implicitly as the public id, but says nothing about request_id or the string/minLength constraints.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Read one automation rule') and scopes it by public id, distinguishing it from list, preview, create, update, and delete siblings in the automation_rules family. The parenthetical previews the returned shape, reinforcing what the tool fetches.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The phrase 'by public id' implies a lookup of an already-known rule, which differentiates it loosely from yardstick_automation_rules_list and the preview tools, but no explicit when-to-use or when-not-to-use guidance is given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.