Create Dashboard

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

With no annotations, the description carries the full burden but only discloses that it accepts two formats, can overwrite existing dashboards, and can set ACLs. It does not mention authentication requirements, error behavior when a dashboard already exists and overwrite is false, or what the response looks like, leaving significant behavioral aspects undeclared.

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 two sentences, front-loaded with the core purpose, and each clause adds relevant detail (formats, overwrite, ACL) without redundancy or fluff.

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 12-parameter tool with no annotations and no output schema, the description is adequate but incomplete. It fails to explain how dashboard_type auto-detection works, what the tool returns, or any prerequisites/error conditions, relying heavily on the schema for parameter semantics.

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%, so the baseline is 3. The description adds some meaning by mentioning the eai:data transport mechanism and clarifying that definition can be a string or object, plus the ACL settings, but this adds limited value beyond the schema's own detailed parameter descriptions.

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 'Create a new dashboard in Splunk', providing a specific verb and resource. It distinguishes itself from sibling tools like get_dashboard_definition and list_dashboards by focusing on creation, and it adds key details about accepted formats and overwrite/ACL options.

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 gives clear context for when to use this tool (creating a dashboard, with optional overwrite for existing ones) but does not explicitly name alternatives or exclusions. The overwrite option implies it can also be used for updates, and the sibling list includes related tools, but no explicit when-not-to-use guidance is provided.

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