get_entity

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

With no annotations, the description carries the full burden. It discloses the matching precedence and duplicate handling, which is valuable behavioral context. However, it does not mention error behavior, output format, or whether the operation is read-only (though 'get detail' implies read-only).

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 compact and front-loaded with the core purpose, then clarifies the lookup behavior. Every sentence adds value with no redundant information.

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 simple lookup tool with 3 parameters and no output schema, the description provides essential invocation details: what is returned (attributes and physical mapping) and how the entity is identified. It does not elaborate on physical mapping, but the description is adequate for selecting and calling this tool.

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 low (only source is described), but the description adds meaning to entityId (preferred) and logicalName (fallback, exact match, first hit on duplicates), partially compensating for the missing schema descriptions. The source parameter is already well-documented in 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 clearly states the tool's purpose: retrieving entity detail including attributes and physical mapping. It distinguishes from sibling tools like list_entities (which lists entities) and get_erd_overview (which provides an overview), though it lacks an explicit verb.

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 gives useful guidance on how to select the target entity (prefer entityId, otherwise exact logicalName match, first hit on duplicates), but it does not explicitly state when to use this tool versus alternatives like list_entities or when not to use it. Usage is implied by the tool name and purpose.

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