snipeit_gen_components_1Creates a new component in Snipe-IT by submitting required name, quantity, and category details through the components API endpoint.
POST /components: Creates a component. Generated from Snipe-IT OpenAPI operation components-1.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | ||
| confirm | No | Required when SNIPEIT_CONFIRM_WRITES=true. Exact string "YES" to apply this write. |
Changes observed during successful MCP inspections.
v0.2.2Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, non-idempotent, and open-world, so the safety profile is carried by structured fields. The description adds no extra behavior context (what must exist first, e.g. a valid category_id, whether confirmation is required, effect of duplicate creation), so it earns little 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?
Very short and front-loaded, but the sentence is padded with a redundant REST path repeat and the boilerplate "Generated from Snipe-IT OpenAPI operation components-1" that conveys nothing actionable.
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?
This is a destructive create over a nested 10-field body with no output schema; the description should at minimum note the required fields and the confirm-write requirement. As written, it is not sufficient for an agent to invoke correctly without reading the schema.
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 only 50% and the description adds zero parameter detail. It does not mention the required body fields (name, qty, category_id) nor explain the `confirm` parameter, which the schema itself describes; a nested body of ten fields is left entirely to the schema.
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 gives a specific verb and resource ("Creates a component"), which is enough to know the general operation. However it never differentiates this from sibling tools like snipeit_gen_components (list) or snipeit_create_maintenance, and the opening REST path restates what the title already says.
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?
There is no guidance on when to use this versus snipeit_raw_request or the other component endpoints, and no mention of prerequisites or the write-confirmation workflow. The agent must infer everything from context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.