get_heap_data

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

No annotations provided, so the description carries full burden. It explains the tool returns aggregated data with different views but omits details on permissions, rate limits, or dependency on a prior heap dump. Adequate but not exhaustive.

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 22-word sentence, front-loaded with the action verb, and covers the core functionality 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?

While the description lists view types, it does not explain that retained_classes requires biggestObjectId, nor does it describe the output structure (no output schema). For a tool with multiple modes and three parameters, more context is needed for complete understanding.

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%, and the description reiterates the enum values without adding new meaning. It confirms the default view but does not detail parameter relationships or formats beyond the schema. Baseline 3 is appropriate.

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 the verb 'Retrieve' and the resource 'aggregated data of a heap dump', and lists the three specific views (biggest objects, retained class lists, class histograms), distinguishing it from sibling tools like create_heap_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?

The description implies usage contexts by listing view types but does not explicitly state when to use this tool versus alternatives (e.g., get_performance_hotspots, list_jvms), nor provides when-not or exclusion criteria.

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