remnawave_get_user

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

Annotations already declare readOnly, idempotent, and non-destructive nature. Description adds the 'specify exactly one identifier' constraint but does not disclose edge cases (e.g., missing user, multiple identifiers provided) or output format. Adequate but not thorough.

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 sentences, no wasted words. First sentence states purpose, second adds essential constraint. Front-loaded and efficient.

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?

Tool is simple and annotations cover safety, but description omits error handling (e.g., user not found) and does not reference output schema. Adequate for basic retrieval but incomplete for robust agent usage.

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 top-level input parameter lacks description (0% coverage), but the description compensates by listing the five identifiers and critically stating that exactly one must be provided, which is not obvious from the schema (all properties optional). This adds significant meaning beyond the 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?

Description clearly states verb 'Get' and resource 'a single user', lists all valid identifiers (UUID, shortUuid, username, telegram ID, email), and includes constraint to specify exactly one. It distinguishes from sibling tools like list_users and create_user.

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?

Description implies usage when you have an identifier and need a single user, but does not explicitly state when to use this over alternatives (e.g., list_users) or exclude contexts. No when-not or alternative guidance given.

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