get_entity_metadata

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

No annotations are provided, so the description carries full burden. It discloses that the tool is read-only (returns metadata) and lists the type of information returned (properties, navigation). However, it does not mention authentication behavior or data center usage, which are implied by parameters.

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 two concise sentences that front-load the purpose and follow with usage advice. No redundant information: every sentence adds value.

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?

Given the presence of an output schema (not shown but implied) and sibling tools, the description covers the core functionality and use case. It could mention default values or authentication handling, but it is sufficient for the primary task of metadata retrieval.

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 only 25% (only entity_name described). The description does not provide any additional meaning for the three undocumented parameters (data_center, auth_user_id, auth_password), leaving the agent with insufficient guidance for these fields.

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 retrieves structured metadata (properties, types, editable, required, picklist, navigation) for an SAP SuccessFactors entity. It uses specific verbs ('retrieve', 'returns') and distinguishes from siblings like list_entities by focusing on metadata of a single entity.

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 explicitly advises using the tool to understand available fields before building business rules. While it does not exclude other tools or mention when not to use it, the context is clear and actionable.

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