imgui_get_viewport_size

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

No annotations are provided, so the description carries the full burden. The description states it returns dimensions, which is minimally transparent about the read-only nature. However, it does not disclose details like whether the returned value is in pixels, physical or logical units, whether it reflects the framebuffer size or the window size, or whether it can be affected by DPI scaling. For a simple getter this is borderline acceptable but lacks depth.

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, concise declarative sentence that fully captures the tool's purpose without any wasted words. It is front-loaded and immediately understandable.

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?

For a parameterless getter with no output schema, the description is reasonably complete. The main gap is not specifying the unit of measurement (pixels) or whether the value reflects logical vs physical dimensions. The sibling pair imgui_set_viewport_size helps provide context, but consumers could benefit from knowing the return format.

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?

There are 0 parameters and schema description coverage is 100% (the schema is empty). With no parameters to document, there is nothing for the description to add regarding parameter semantics. A baseline of 4 is appropriate for a parameterless tool.

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 ('Get') and resource ('viewport/SDL window dimensions'). It specifies that it returns dimensions, which is the core purpose. However, it does not distinguish itself from the sibling imgui_set_viewport_size in terms of being a read vs write operation, though the verb 'Get' strongly implies the read nature.

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?

There is no guidance on when to use this tool versus alternatives. Since it's a getter, one could reasonably want to know when to prefer it over imgui_get_window_rect or imgui_get_state. No when-to-use or when-not-to-use context is provided.

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