get_ui_action

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

Annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=true, indicating a safe read operation. The description adds value by disclosing the requirement 'requires SCRIPTING_ENABLED=true', which is a behavioral constraint not covered by annotations. It does not contradict annotations.

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 purpose and a key prerequisite without wasted words. It is highly efficient.

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?

Given the tool is a simple one-parameter getter with no output schema, the description adequately covers the core behavior (returns full details/script) and a condition (SCRIPTING_ENABLED=true). It does not need to enumerate return fields since it says 'full details'. Nearly complete for the context.

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 coverage is 100% (the parameter 'sys_id' has a description). The tool description says 'Get full details and script of a UI Action', which implies the parameter identifies the UI Action. This adds no additional meaning beyond what the schema already provides, so baseline 3 is appropriate.

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 verb 'Get' and the resource 'UI Action' with specifics ('full details and script'). It distinguishes itself from sibling tools like list_ui_actions (which lists) and update_ui_action (which modifies).

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 mentions a prerequisite (requires SCRIPTING_ENABLED=true), which provides some usage context. However, it does not explicitly state when to use this tool versus alternatives like list_ui_actions for listing or update_ui_action for editing, nor does it provide when-not-to-use guidance.

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