get_process_automation

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

The annotations already declare readOnlyHint=true, so the read-only nature is covered. The description does not add extra behavioral context such as permissions, side effects, or return format, but it is consistent with the annotation. No contradiction exists, and the annotation lowers the bar for additional disclosure.

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?

The description is a single, front-loaded sentence that conveys the essential purpose without any redundant words. It is concise and clear, earning the maximum score for structure.

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?

This is a simple get tool with one parameter, no output schema, and read-only annotations. The description is adequate for the intended use: retrieving details of a specific playbook/process. While it does not enumerate what 'details' includes, the tool's simplicity and the read-only annotation make this a minor gap. Overall, it is complete enough for an agent to invoke correctly.

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?

The input schema covers the single parameter name_or_sysid with a clear description ('Playbook or process name or sys_id'). Schema coverage is 100%, so the baseline of 3 applies. The tool description adds no further parameter semantics beyond what the schema already provides.

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?

The description clearly states the action ('Get details') and the specific resource ('Process Automation Designer playbook or process'), making it easy to distinguish from siblings like list_process_automations which lists items rather than retrieving one. The verb 'get' plus the concrete resource leaves no ambiguity about the tool's function.

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 description implies usage: to retrieve details for a single playbook/process. However, it does not explicitly state when to use this tool over alternatives such as list_process_automations, nor does it mention any prerequisites or exclusions. This is sufficient for a simple get tool but lacks explicit guidance.

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