create_device

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

Annotations indicate readOnlyHint=false (creation) and destructiveHint=false, which the description confirms as adding a device. However, it does not disclose potential side effects such as triggering provisioning or requiring admin permissions, offering only basic behavioral context beyond the 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 two sentences: first stating the action, then listing fields. It is concise and front-loaded with no extraneous information.

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, the description omits details on the response (e.g., created device ID). It also does not specify constraints on field values or preconditions. For a creation tool with nested parameters, this leaves gaps for the agent.

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 input schema only defines a generic 'body' object without internal properties, but the description adds significant meaning by enumerating required fields (customerId, networkAddress, longName, supportedOs, deviceClass) and optional ones, compensating for the schema's lack of detail.

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 'Add a new device to N-central,' using a specific verb and resource. It distinguishes itself from sibling tools like create_customer or add_device_note by focusing on device creation.

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 lists required and optional fields but does not provide guidance on when to use this tool versus alternatives, nor does it mention prerequisites like an existing customer or site. The context for selection among siblings is missing.

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