sap_set_field

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

Description adds behavioral nuance beyond annotations: the note about pressing Enter for validation reveals post-set behavior. Annotations already indicate non-read-only and non-destructive nature, so no contradiction.

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 concise sentences, front-loaded with purpose, no redundancy. Every sentence adds essential information: what it does, when to use alternative, and an operational tip.

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 two-parameter tool with an output schema (not shown but present), the description covers the core action, single-use case, and validation hint. Lacks only minor details like whether field_id is a technical name or caption, but overall adequate.

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 0%, but description only uses the parameter names 'field_id' and 'value' without elaboration on formats, IDs, or value constraints. Does not compensate for missing schema descriptions.

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?

Clear verb-resource pairing: 'Set a value in a field' specifies exactly what the tool does. Mentions alternative tool sap_set_batch_fields, distinguishing single-field vs. batch operations, and the context 'on the current SAP screen' adds precision.

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?

Explicitly states when to use this tool alone (single field) and provides a direct alternative (sap_set_batch_fields). Also gives practical guidance that pressing Enter may be needed for validation, which is a key usage hint.

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