Get Entity XDATA

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

readOnlyHint=true already establishes this as a safe read, so the bar is lower, and the description does add real behavioral value: the return is a map of app to value list, and apps without XDATA are omitted rather than returned empty. It stops there, saying nothing about missing entities, empty results overall, or handle validity.

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?

Two tight sentences with no filler, and the return-shape information leads. It could be a touch more informative given the space it saves, but nothing is wasted.

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?

With an output schema present, the description need not explain return values, yet it partially does. For a simple annotated read tool with full schema coverage this is close to adequate, but the absence of any usage context or handling of entities lacking XDATA entirely leaves a gap.

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 both parameters are documented there (including 'omit for every app'), so the schema does the heavy lifting. The 'app with no XDATA is simply absent' note slightly illuminates the app_name filter but adds no syntax or formatting detail beyond the schema.

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 conveys that this returns extended entity data keyed by app, and the title supplies the verb, but the text itself never states the action ("retrieve/return XDATA for an entity"). It reads as a return-shape footnote rather than a purpose statement, so an agent must infer intent from the name/title.

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 versus alternatives, no mention of the obvious counterpart entity_set_xdata, and no note on prerequisites such as the entity existing or having XDATA attached. Usage must be fully inferred.

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