Create Supplier

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

Annotations indicate write operation (readOnlyHint=false) and non-idempotent, non-destructive. Description adds a behavioral note about dry-run confirmation and specifies return formats (markdown or JSON), providing context 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?

Description is three sentences, front-loads purpose, and includes essential behavioral note. No wasted words.

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 covers return format (since no output schema) and dry-run caution. Minor gaps: no mention of uniqueness constraints on name/slug or guidance on response format selection. Still fairly complete for a create tool.

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 71%, so parameters are mostly documented. The description adds no new parameter-specific meaning beyond what's in the schema (e.g., return format is mentioned but already in schema). Baseline 3 due to high schema coverage.

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 'Create a new supplier in NetBox', aligning with the tool name and distinguishing it from sibling tools like netbox_update_supplier and netbox_list_suppliers.

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 instructs to 'Ask before calling if the user wanted a dry-run', providing one usage caution but no explicit guidance on when to use this tool versus alternatives like netbox_update_supplier or netbox_get_supplier.

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