get-dashboard-service

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

With no annotations, the description should disclose behavioral traits like auth requirements, error handling (e.g., if not found), or side effects. The current text offers none, leaving the agent blind to important behaviors.

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, short sentence, achieving conciseness but sacrificing clarity. It is not verbose, but it could add context without becoming overly long, such as listing key parameters or behavior.

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 no output schema, no annotations, and three parameters with low coverage, the description is insufficient. It fails to explain what a dashboard service is, what data is returned, or how to use the 'include' and 'fields' parameters.

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 low (33%). The description adds no parameter meaning beyond the schema. The phrase 'by name' implies 'fqn' is the name, but 'fields' and 'include' remain unexplained, forcing the agent to rely on minimal schema info.

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 'Get dashboard service by name' clearly states the action (get) and resource (dashboard service) and retrieval method (by name). However, it does not differentiate from siblings like 'get-dashboard' or 'list-dashboard-services', which could cause confusion.

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?

No guidance is provided on when to use this tool versus alternatives such as 'list-dashboard-services' or other get-by-name tools. There is no mention of prerequisites, exclusions, or context.

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