Get User

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

No annotations, but description states it returns specific fields (name, email, phone, title, etc.). Does not disclose error handling or permissions, but sufficient for a simple read operation.

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?

Single sentence, no filler. Efficient and front-loaded with the essential action and return values.

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?

Adequate for a simple lookup tool with one parameter and no output schema. Mentions returned fields, though 'etc.' is vague. Could be more specific but sufficient.

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 covers 100% of the single parameter with a description. Description adds 'by user_name' but this is redundant; no additional meaning beyond 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?

Clear verb+resource: 'Look up a ServiceNow user by user_name.' Distinct from siblings which are mostly incident-related or CMDB searches.

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?

Implied usage: look up a user by exact username. No explicit when-not-to-use or alternatives. However, context suggests it's the only user lookup tool.

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