read_entity

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

With no annotations provided, the description carries the behavioral disclosure burden. 'Read' implies a safe, non-mutating operation, which is useful. However, the description does not disclose what happens if the named entity does not exist (error vs. empty result), whether this is a read-only operation, or any access/authentication requirements. The read semantics are implied but not explicit.

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 short sentence with no wasted words. The core action and target are front-loaded, and there is no redundancy or filler. For a simple one-parameter tool, this length is appropriate.

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 tool has one required parameter, no annotations, and no nested objects. The output schema exists, so return-value documentation is not required from the description. For a simple single-entity read tool with one parameter, the description covers the essential information an agent needs to invoke it correctly; the gaps (error behavior) are minor given the tool's low complexity.

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 description coverage is 0%, so the description must compensate for the single parameter, 'name'. The description does mention that the tool reads 'by name', which gives some meaning to the parameter. However, it does not specify what format the name must take (e.g., exact string, case sensitivity, ID vs. display name) or whether it refers to a fully-qualified path. Minimal value is added beyond the schema field title.

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 'Read a configured entity by name' states a clear verb (read) and resource (configured entity) with a specific scope (by name). It does not explicitly differentiate from siblings, but 'read' is naturally contrasted with list_entities and write_entity, so an agent can infer this is the single-entity retrieval counterpart.

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?

No guidance is given on when to use this tool versus list_entities or write_entity. The description does not state that this is for retrieving a single specific entity while list_entities enumerates all entities, nor does it mention any prerequisites such as the entity needing to already exist. Usage context must be inferred entirely from sibling names.

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