imgui_export_json

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

With no annotations provided, the description carries the transparency burden. It explains what the output contains (version info, window properties, widget definitions) which is reasonable but doesn't disclose side effects (if any), whether this is read-only or mutates state, or any formatting/pretty-print behavior. It does disclose the path behavior (optional file write vs inline return) which is useful.

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?

A single, dense sentence that covers the tool's purpose and output content with zero waste. Every element contributes to understanding.

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 a single optional parameter, no output schema needed (output shape is well-described in prose), and no annotations required, this description is largely complete. The only minor gap is not mentioning the relationship to imgui_import_json for round-tripping workflows, but this isn't essential for basic usage.

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 single parameter 'path' is already documented in the schema. The description reinforces the path behavior by mentioning inline return when omitted, which adds a small amount of value beyond the schema, but largely the schema already handles parameter documentation.

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 this tool exports the current UI layout as structured JSON, listing the specific contents (version info, window properties, widget definitions). It distinguishes itself from sibling tools like imgui_export_cpp and imgui_export_lua which export to different formats, and from imgui_get_layout which is a related but distinct operation.

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 this is for exporting layout data as JSON, which differentiates it from export_cpp/export_lua siblings, but it doesn't explicitly state when to use this vs alternatives, nor does it mention the reciprocal tool imgui_import_json for round-tripping or when inline vs file export is preferable.

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