Create Platform

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

Annotations already indicate this is a write operation (readOnlyHint=false) and openWorldHint=true. The description adds that it 'adds a new row to NetBox' and describes the return format, but does not clarify side effects like duplicate handling or external interactions implied by openWorldHint.

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 largely concise with four sentences, but includes a redundant second sentence ('This adds a new row to NetBox') that restates the purpose. It is front-loaded with the key verb and resource, and the remaining sentences provide useful usage and output info.

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 creation tool with 8 parameters and no output schema, the description covers the output format and a usage note but lacks details on dry-run implementation, validation of required parameters, and handling of nested objects like custom_fields. It is adequate but not comprehensive.

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 description coverage is high (88%), so the schema already documents parameters well. The description mentions the response_format parameter indirectly in the Returns section but adds no additional semantic context for other parameters. Baseline 3 is appropriate.

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 'Create a new platform in NetBox', specifying the action (create) and the resource (platform). It is unambiguous and distinct from sibling tools like netbox_update_platform or netbox_delete_platform.

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 includes an instruction to 'Ask before calling if the user wanted a dry-run', which provides a usage guideline. However, it does not offer guidance on when to use this tool versus alternatives (e.g., checking existence first) or prerequisites, making it only minimally helpful.

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