> ## Documentation Index
> Fetch the complete documentation index at: https://docs.supercycle.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Tools

> Tools available in the Operators MCP

<Info>List tools support pagination (`page`, `per_page` max 100), sorting (`sort`, `sort_direction`), and date filtering (`created_after`, `created_before`, `updated_after`, `updated_before`) in `YYYY-MM-DD` format.</Info>

***

## Cycles

<Tabs>
  <Tab title="list_cycles">
    List cycles filtered by status, method, dates, and packing status.

    | Parameter                               | Values                                                                                  |
    | --------------------------------------- | --------------------------------------------------------------------------------------- |
    | `status`                                | `upcoming`, `active`, `complete`, `to_fulfill`, `to_receive`, `to_restock`, `cancelled` |
    | `method_type`                           | `calendar`, `subscription`, `membership`, `resale`                                      |
    | `packing_status`                        | `pending`, `printed`, `packed`                                                          |
    | `rental_start_from` / `rental_start_to` | Date range for rental start                                                             |
    | `customer_email`                        | Partial match                                                                           |
    | `item_title`                            | Partial match                                                                           |

    Optionally include related data with `include_customer`, `include_item`, `include_order`, `include_line_item`.
  </Tab>

  <Tab title="get_cycle">
    Get full details of a single cycle by ID.

    | Parameter | Required | Description               |
    | --------- | -------- | ------------------------- |
    | `id`      | Yes      | Cycle ID (e.g. `SC-1234`) |

    Returns the complete cycle record with customer, item, order, charges, and return data.
  </Tab>

  <Tab title="update_cycle">
    Update a cycle's packing status, dates, or item assignment. Requires confirmation.

    | Parameter                      | Description                                  |
    | ------------------------------ | -------------------------------------------- |
    | `id`                           | Cycle ID (required)                          |
    | `packing_status`               | `pending`, `printed`, `packed`               |
    | `item_id`                      | Item ID to assign                            |
    | `rental_start` / `rental_end`  | Reschedule dates (`YYYY-MM-DD`)              |
    | `fulfilled_at` / `received_at` | Mark as fulfilled or received (`YYYY-MM-DD`) |
  </Tab>
</Tabs>

***

## Inventory

<Tabs>
  <Tab title="list_items">
    List inventory items filtered by visibility, status, condition, and availability.

    | Parameter           | Values                                          |
    | ------------------- | ----------------------------------------------- |
    | `visibility`        | `available`, `unavailable`, `sold`, `retired`   |
    | `processing_status` | `unprocessed`, `processed`                      |
    | `available`         | `true` (not rented), `false` (currently rented) |
    | `product_title`     | Partial match                                   |
    | `sku`               | Partial match                                   |
    | `condition_id`      | Filter by condition                             |

    Returns item ID, product/variant title, SKU, serial, visibility, condition, and pick location.
  </Tab>
</Tabs>

***

## Customers

<Tabs>
  <Tab title="list_customers">
    List customers filtered by activity, value, and balance.

    | Parameter                       | Description                 |
    | ------------------------------- | --------------------------- |
    | `customer_email`                | Partial match               |
    | `name`                          | Partial match               |
    | `has_active_rentals`            | `true` or `false`           |
    | `lifetime_value_min_cents`      | Minimum lifetime value      |
    | `outstanding_balance_min_cents` | Minimum outstanding balance |

    Sortable by `lifetime_value_cents`, `rentals_count`, `outstanding_balance_cents`.
  </Tab>
</Tabs>

***

## Returns

<Tabs>
  <Tab title="list_returns">
    List returns filtered by status, receival, and credit status.

    | Parameter         | Values                                                                       |
    | ----------------- | ---------------------------------------------------------------------------- |
    | `status`          | `requested`, `expected`, `received`, `in_progress`, `completed`, `cancelled` |
    | `receival_status` | `unreceived`, `partially_received`, `received`                               |
    | `credit_status`   | `uncredited`, `partially_recredited`, `recredited`                           |
    | `incomplete`      | `true` to show only incomplete returns                                       |
    | `customer_email`  | Partial match                                                                |

    Optionally include related data with `include_customer`, `include_return_lines`.
  </Tab>

  <Tab title="get_return">
    Get full details of a single return by ID.

    | Parameter | Required | Description              |
    | --------- | -------- | ------------------------ |
    | `id`      | Yes      | Return ID (e.g. `#2001`) |

    Returns the complete return record with customer, return lines, conditions, return method, and tags.
  </Tab>

  <Tab title="create_return">
    Create a return order for a customer. Requires confirmation.

    | Parameter            | Required | Description                                         |
    | -------------------- | -------- | --------------------------------------------------- |
    | `customer_id`        | Yes      | Customer email or Shopify ID                        |
    | `rental_ids`         | Yes      | Array of rental IDs (e.g. `['SC-1042', 'SC-1043']`) |
    | `return_method_type` | No       | `collection` or `return_label`                      |
  </Tab>

  <Tab title="update_return">
    Update a return order's status or return line statuses. Requires confirmation.

    | Parameter      | Description                                                                    |
    | -------------- | ------------------------------------------------------------------------------ |
    | `id`           | Return ID (required)                                                           |
    | `status`       | `requested`, `expected`, `received`, `in_progress`, `completed`, `cancelled`   |
    | `return_lines` | Array of `{ id, status }` where status is `awaiting`, `received`, or `missing` |
  </Tab>
</Tabs>

***

## Charges

<Tabs>
  <Tab title="list_charges">
    List charges with optional status filtering.

    | Parameter                               | Description                                  |
    | --------------------------------------- | -------------------------------------------- |
    | `status`                                | `paid`, `unpaid`, `cancelled` (default: all) |
    | `customer_email`                        | Partial match                                |
    | `amount_min_cents` / `amount_max_cents` | Filter by amount                             |
    | `category_type`                         | `Checkout`, `Generic`, `BillingCycle`        |

    Optionally include related data with `include_customer`, `include_dunning`.
  </Tab>
</Tabs>

***

## Pricing

<Tabs>
  <Tab title="list_method_options">
    List pricing options for a given method, filtered by product and price range.

    | Parameter                             | Required | Description                                        |
    | ------------------------------------- | -------- | -------------------------------------------------- |
    | `method_type`                         | Yes      | `subscription`, `membership`, `calendar`, `resale` |
    | `product_id`                          | No       | Filter by product                                  |
    | `price_min_cents` / `price_max_cents` | No       | Filter by price                                    |

    Returns method-specific fields (e.g. recurring price and billing interval for subscriptions, duration for calendar).
  </Tab>
</Tabs>

***

## Availability

<Tabs>
  <Tab title="create_blocked_date">
    Block an item, variant, or product from being booked over a date range. Requires confirmation.

    | Parameter       | Required | Description                                                                           |
    | --------------- | -------- | ------------------------------------------------------------------------------------- |
    | `resource_type` | Yes      | `item`, `variant`, or `product`                                                       |
    | `resource_id`   | Yes      | Formatted or numeric ID for items; Shopify ID or numeric ID for variants and products |
    | `from`          | No       | First blocked date (`YYYY-MM-DD`, inclusive). Omit for open-ended start.              |
    | `to`            | No       | Last blocked date (`YYYY-MM-DD`, inclusive). Omit for open-ended end.                 |
    | `description`   | No       | Optional note (e.g. `Repairs`, `Reserved for photoshoot`)                             |

    At least one of `from` or `to` must be provided. Dates are day-bounded in the shop timezone.
  </Tab>
</Tabs>

***

## Tags

<Tabs>
  <Tab title="list_tags">
    List all tags on a cycle, item, or return.

    | Parameter       | Required | Description                  |
    | --------------- | -------- | ---------------------------- |
    | `resource_type` | Yes      | `cycle`, `item`, or `return` |
    | `resource_id`   | Yes      | Resource ID (e.g. `#1042`)   |
  </Tab>

  <Tab title="add_tag">
    Add a tag to a cycle, item, or return. Idempotent. Requires confirmation.

    | Parameter       | Required | Description                  |
    | --------------- | -------- | ---------------------------- |
    | `resource_type` | Yes      | `cycle`, `item`, or `return` |
    | `resource_id`   | Yes      | Resource ID (e.g. `#1042`)   |
    | `tag`           | Yes      | Tag title to add             |
  </Tab>

  <Tab title="remove_tag">
    Remove a tag from a cycle, item, or return. Idempotent. Requires confirmation.

    | Parameter       | Required | Description                  |
    | --------------- | -------- | ---------------------------- |
    | `resource_type` | Yes      | `cycle`, `item`, or `return` |
    | `resource_id`   | Yes      | Resource ID (e.g. `#1042`)   |
    | `tag`           | Yes      | Tag title to remove          |
  </Tab>
</Tabs>

***

## Comments

<Tabs>
  <Tab title="add_comment">
    Add a comment/note to a cycle, item, customer, or return. Requires confirmation.

    | Parameter       | Required | Description                              |
    | --------------- | -------- | ---------------------------------------- |
    | `resource_type` | Yes      | `cycle`, `item`, `customer`, or `return` |
    | `resource_id`   | Yes      | Resource ID or email for customers       |
    | `body`          | Yes      | Comment text                             |
  </Tab>
</Tabs>