create_heap_dump

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

No annotations are provided, so the description carries the full burden. It describes the tool's action (dumping heap to HPROF and loading for analysis) and implies an asynchronous operation by requiring a status check. The description does not disclose potential side effects (e.g., memory usage during heap dump) but is generally transparent about the process.

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 three sentences, each serving a distinct purpose: first describes the action, second explains the follow-up steps, third hints at a discovery tool. There is no redundancy or unnecessary detail.

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 the complexity of the tool (heap dump, loading, asynchronous progress), the description adequately covers the workflow and dependencies on sibling tools. It could mention that heap dumps can be large or require significant memory, but the provided information is sufficient for correct invocation.

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?

Although schema coverage is 100% and the schema describes parameters adequately, the description adds value by explaining that omitting 'pid' when a container is specified will use the topmost JVM. This extra context goes beyond the schema and aids correct parameter selection.

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 'dump' and the resource 'heap of a locally running JVM or of a JVM inside a Docker container'. It also mentions the output format 'HPROF file' and the subsequent loading for analysis. This distinguishes the tool from siblings like check_status, get_heap_data, and list_jvms.

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 explicitly outlines the required workflow: 'You must call check_status to check the loading progress and - after this returns 'data_ready' - retrieve data with get_heap_data.' It also suggests using list_jvms for discovery, providing clear guidance on when to use this tool and what to do after.

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