Get User Profile

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

Annotations already declare readOnlyHint=true, and the description consistently describes a read operation. It adds context by mentioning error handling (returns error object if not found, raises ValueError if client not configured), which goes beyond 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?

The description is extremely concise: a single-line summary followed by structured Args/Returns/Raises sections. Every sentence adds value, and the purpose is front-loaded.

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 tool's simplicity (one parameter, no nested objects), the output schema exists, and the description covers essential aspects: parameter types, return format (JSON string or error object), and error conditions. It is fully 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?

The parameter description in the schema lists identifier types, and the tool description elaborates with examples (email, username, key, account ID). With 100% schema coverage, the description adds valuable clarification.

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 'Retrieve profile information for a specific Jira user.' It uses a specific verb ('retrieve') and resource ('profile information for a specific Jira user'), distinguishing it from sibling tools like jira_get_issue or jira_search.

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 includes args, returns, and raises sections, specifying the user_identifier parameter with types. It does not explicitly state when not to use it or compare with alternatives, but given the tool's specificity, the guidance is sufficient.

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