netbox_create_object

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

With no annotations, the description carries the behavioral burden. It does disclose a meaningful caveat: 'Disabled when the server is running in read-only mode.' However, it does not mention authorization requirements, error behavior, or whether creation is idempotent, so significant behavioral gaps remain.

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 compact and front-loaded with the primary action and the read-only caveat. The Args block is structured and every line adds useful information without repetition or fluff.

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?

For a two-parameter creation tool, the description covers endpoint format, data meaning, the read-only caveat, and the prerequisite schema lookup. With an output schema available, return values are covered elsewhere; only minor omissions like explicit permission or error-handling details keep this from a 5.

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 lists 'endpoint' as a string and 'data' as an object, with 0% schema description coverage. The description compensates fully by explaining endpoint as an 'app.endpoint' string with a concrete example and describing data as field values, directing the agent to netbox_get_schema for required and valid fields.

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 the verb and resource: 'Create a new object at a NetBox endpoint.' It also gives the endpoint format ('app.endpoint', e.g. 'dcim.sites'), which distinguishes this creation tool from siblings like netbox_update_object and netbox_delete_object.

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 clearly instructs the agent to call netbox_get_schema first to discover required and valid fields, establishing a prerequisite workflow. It does not explicitly contrast with update/delete/list alternatives, but the 'Create a new object' framing gives clear context for when this tool applies.

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