get_user_info

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

No annotations are provided, so the description must disclose behavioral traits. It only says 'Get,' which implies read-only, but omits authentication needs, rate limits, or error conditions. Minimal disclosure for a tool without annotations.

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?

Extremely short (one sentence), which is efficient, but it sacrifices necessary information. Conciseness should not come at the cost of clarity—here, it lacks detail on output or usage context.

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?

With an output schema present, return values are covered. However, the tool has sibling tools like get_all_users, and the description doesn't clarify when to use which. Also, no behavioral info given lack of annotations. Adequate but not 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 0%, yet the description adds little beyond the schema: it mentions 'specific Splunk user' for the username parameter but no format, constraints, or examples. Only marginal value added.

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?

Description clearly states 'Get detailed information about a specific Splunk user,' which identifies the verb and resource. It distinguishes from get_all_users by specifying 'specific' rather than 'all,' but doesn't explicitly contrast.

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?

Implies use when retrieving details on a known user, but lacks explicit guidance on when not to use it (e.g., for listing users) or alternatives. Context is clear but not fully articulated.

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