Get Kibana saved object

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

Discloses that it decodes inline JSON fields and resolves references, beyond the readOnlyHint annotation. Also specifies which indices are accessed.

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?

Three concise sentences, front-loaded with action, then processing details, then access requirements. No redundancy.

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, description explains output characteristics (decoded fields, resolved references) and access needs. Sufficient for a simple fetch tool.

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 covers ref parameter with description; description adds example format, reinforcing the syntax. Value added over schema is moderate.

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?

Clearly states the tool fetches a Kibana saved object by type:id reference, with specific examples. Differentiates from siblings by specifying it reads Kibana indices.

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?

Explains use case and prerequisites (API key needs read access to specified indices). Does not explicitly state when not to use or contrast with siblings like get_document.

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