get_entity_details

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

No annotations are provided, so the description must disclose behavior on its own. It only says 'Get', which suggests a read-only operation, but it does not mention that the entity is resolved from a Mermaid diagram, how the optional diagram parameter affects execution, or what happens if the entity is not found.

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 17-word sentence with no filler. The main verb and object are front-loaded, and every word contributes to the purpose.

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?

The description gives a reasonable summary of the return content in the absence of an output schema, and the input schema covers the diagram parameter. However, the description does not explain that the entity comes from a diagram or specify not-found behavior, so it is not fully complete.

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%, so both parameters are already documented. The description adds a little meaning by clarifying that entityName refers to the specific entity and that details include attributes, types, and keys, but it adds nothing about the diagram parameter beyond what the schema provides.

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 the resource, 'detailed information about a specific entity', and explicitly lists what is included (attributes, types, keys). This distinguishes the tool from siblings like list_entities (which lists all entities) and get_relationships (which focuses on relationships).

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 phrase 'specific entity' implies the tool is for a single entity lookup, but there is no explicit guidance on when to use this tool versus alternatives such as list_entities or get_relationships. The usage context is only implied, not stated.

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