ptero_app_get_users

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

No annotations are provided, so the description carries the full burden. It mentions 'raw' and 'can be large', indicating unfiltered data and potential size issues, but lacks details on authentication, rate limits, side effects, or return format. This is adequate but not comprehensive.

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 a single sentence that efficiently conveys the endpoint, a warning, and usage guidance. Every word adds value; there is no redundancy or wasted space.

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 no output schema, low schema coverage, and the tool's nature as a raw API call, the description fails to explain how to use the parameters or interpret the response. The agent is left to guess, making it incomplete for effective invocation.

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?

With 0% schema description coverage, the description must add meaning to the parameters, but it provides no explanation of 'query' or 'body'. The schema itself offers no descriptions either. The agent has no clue how to use these parameters.

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 explicitly states the endpoint and resource ('GET /api/application/users'), clearly indicating it retrieves a list of users. It directly distinguishes itself from sibling tools by recommending alternative tools for typical use cases.

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 tells the agent to prefer ptero_ai_list_users or ptero_ai_search_users instead, providing clear guidance on when not to use this tool and offering alternatives. The warning 'can be large' further informs usage context.

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