get_heap_dump_metadata

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

No annotations provided; description only states a read operation without disclosing authentication, rate limits, or behavior when actuator disabled. Minimal behavioral context.

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?

Single sentence, no waste, but critically under-informative. Could include parameter explanation and return value.

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?

Incomplete for a tool with 1 undocumented parameter and no output schema. Missing explanation of return format, parameter usage, and prerequisites.

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?

Single parameter 'application' is undocumented in both description and schema (0% coverage). Description adds no meaning beyond the parameter name.

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?

Description clearly states verb 'Read' and specific resource '/actuator/heapdump response headers', distinguishing it from sibling tools like 'get_heap_info' or 'get_thread_dump'.

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?

Implies usage when actuator downloads are enabled, but no explicit guidance on when to use this vs alternatives, nor exclusions.

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