splunk_update_dashboard

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

With no annotations, the description carries the full behavioral burden. It discloses that this is a mutation requiring write mode, but it does not specify whether the XML/JSON update replaces the whole definition, what happens to omitted fields, or what permissions beyond write mode are needed.

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 front-loaded with the core action and prerequisite, followed by a concise argument list. Every sentence and parameter note serves a purpose without unnecessary repetition.

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?

The presence of an output schema means return values need not be explained. However, for a mutation tool with no annotations and 0% schema descriptions, the definition should say more about overwrite behavior and side effects to be fully complete.

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 must document parameters. It describes all four arguments: name, xml_data, label, and app, though it does not add format details for xml_data beyond 'Updated XML/JSON definition.'

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 a specific verb and resource: update an existing dashboard definition. This distinguishes it from sibling tools such as create_dashboard, get_dashboard, and delete_dashboard.

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?

It specifies that the dashboard must already exist and that write mode is required, giving clear usage context. It does not explicitly point to create_dashboard as the alternative for new dashboards, but the implied distinction is clear.

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