spraay_robots_register

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

Annotations indicate mutation (readOnlyHint=false) and non-idempotent (idempotentHint=false). Description adds 'Free to call' but doesn't elaborate on side effects, required permissions, or behavior on duplicate calls. Adequate but minimal 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?

Two sentences, no extraneous words. Purpose is front-loaded ('Register Robot'). Ideal for quick scanning.

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?

Description is minimal; it doesn't explain the payload structure or what registration implies. Given output schema exists, return format is covered, but the tool's purpose could be expanded. Adequate for a simple tool but could be more informative.

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 already describes 'body' as 'JSON request body' with 100% coverage. Description restates 'Pass the request payload as a JSON string via the body argument,' adding no new semantic value.

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 verb 'Register' and resource 'Robot' clearly indicate the tool's function. It distinguishes from siblings like deregister and list. However, 'RTP' is unexplained and the description could be more specific about what registration entails.

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?

No guidance on when to use this tool versus alternatives like spraay_robots_update or spraay_robots_complete. 'Free to call' is a minor note but does not provide context for appropriate usage.

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