Skip to main content
Glama

Delete Order

starshipit_delete_order
DestructiveIdempotent

Permanently delete an unshipped StarShipIt order created in error. Use only for irreversible removal; archive orders you want to retain instead.

Instructions

Permanently delete an order from StarShipIt. This action is irreversible — the order will be removed from the system entirely.

When to use: Only use on unshipped orders that were created in error and must be removed. For orders you want to retain but hide from the queue, use starshipit_archive_order instead.

Parameters:

  • order_id (required) — StarShipIt internal order ID to permanently delete

Returns: Confirmation message on success.

Warning: This is a destructive, permanent action. The order cannot be recovered after deletion.

Errors: 404 if order not found; 409 if the order has already been shipped (cannot delete shipped orders — use archive instead); 401 if API keys invalid.

Input Schema

NameRequiredDescriptionDefault
order_idYesStarShipIt internal order ID to permanently delete

Output Schema

NameRequiredDescriptionDefault
errorsNoValidation or processing errors returned by StarShipIt
objectNoThe response payload when StarShipIt returns a non-object value
successNoStarShipIt success flag (a boolean on most endpoints)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already flag destructiveHint/idempotentHint, but the description goes well beyond them by disclosing irreversibility, that the order is removed entirely, and specific error semantics (404 not found, 409 shipped, 401 auth) that tell the agent exactly how failure modes map to preconditions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core action and clearly sectioned with headers for when-to-use, parameters, returns, and errors, though the irreversibility warning is stated twice (opening line and Warning block), a minor redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter destructive tool this covers everything an agent needs: scope, alternative routing, return confirmation, and error-condition behavior, with an output schema already handling return structure.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and the single parameter's schema text is verbatim identical to the description's parameter note, so the description adds no meaning beyond the schema; baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Permanently delete an order from StarShipIt') and immediately clarifies the permanence, which distinguishes it from the sibling archive/restore tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly names the when-to-use condition ('Only use on unshipped orders created in error') and routes the agent to the named alternative `starshipit_archive_order` for retain-but-hide cases, plus documents 409 for shipped orders as a further exclusion.

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