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

# Tool reference

> Explore the tools available through the Redo MCP Server

## Features

The Redo MCP Server provides tools across orders, returns, discounts, customers, marketing, and analytics.

Permission names match those shown in Redo. When a tool lists multiple permissions, having any one of them grants access. An em dash means the tool does not require an additional role permission.

### Orders

| Tool             | Description                                                                                                             | Required permission |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------- |
| **list\_orders** | Search and list orders by order name, customer email, provider order ID, or date range. Supports pagination.            | —                   |
| **get\_order**   | Get detailed information about a specific order including customer, items, totals, discounts, shipping cost, and taxes. | —                   |

### Customers

| Tool                | Description                                                                                                                                                                | Required permission   |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
| **list\_customers** | Search and list customer records by name, email, phone, or segment membership. Supports pagination. Use to find customer IDs before calling get\_customer.                 | View Customer Details |
| **get\_customer**   | Get detailed customer information including contact methods, marketing consent, linked accounts, tags, segment memberships, addresses, custom fields, and loyalty details. | View Customer Details |

### Returns

<Note>
  The returns tools are only available when Redo Returns is enabled for your account.
</Note>

| Tool                        | Description                                                                                                                                                                                             | Required permission     |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
| **create\_draft\_return**   | Start a merchant-created draft return for an order. Returns returnable items, non-returnable items, and the draft return ID.                                                                            | —                       |
| **manage\_draft\_return**   | Configure a draft return step-by-step by selecting items, editing quantities, answering return-flow questions, choosing compensation, setting overrides, selecting shipment, and configuring exchanges. | —                       |
| **submit\_draft\_return**   | Submit a fully configured draft return once it reaches the ready step. Creates the actual return and returns the return ID.                                                                             | —                       |
| **list\_returns**           | Search returns by order name, customer email, status, or date range. Supports pagination.                                                                                                               | View Returns            |
| **get\_return**             | Get full return details including items, status, compensation totals, and order info.                                                                                                                   | View Returns            |
| **process\_return**         | Accept or reject each item in a return, with options for restocking and grading.                                                                                                                        | Process/Reject Returns  |
| **update\_return\_status**  | Change a return's status (in\_transit, delivered, needs\_review, in\_review, flagged, pre\_shipment).                                                                                                   | Edit Return Information |
| **reopen\_return**          | Reopen a completed or rejected return, resetting items back to open.                                                                                                                                    | Re-open Returns         |
| **close\_return**           | Close a return without processing — marks all items as complete with no further action.                                                                                                                 | Close Returns           |
| **create\_return\_comment** | Add a comment to a return's timeline.                                                                                                                                                                   | Edit Return Information |
| **approve\_return**         | Approve a return so the customer can proceed with shipping items back.                                                                                                                                  | Approve/Deny Returns    |
| **list\_return\_tags**      | List every return tag defined for the authenticated team. Read-only, no input.                                                                                                                          | —                       |
| **upsert\_return\_tag**     | Create a new tag, recolor an existing tag, or rename a tag (rename cascades to returns and saved view filters).                                                                                         | —                       |
| **delete\_return\_tag**     | Permanently delete a tag and strip it from every return and saved view filter that referenced it. Destructive.                                                                                          | —                       |

### Marketing

<Note>
  The marketing tools are only available when Redo Marketing is enabled for your account.
</Note>

| Tool                                     | Description                                                                                                                                                                     | Required permission                                     |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| **list\_campaigns**                      | List marketing campaigns, filtered by channel (email/SMS), status, name, or scheduled-date range. Returns a summary per campaign. Supports pagination.                          | View Marketing or Manage Campaigns                      |
| **get\_campaign**                        | Get full details for a campaign including its templates (email subject lines or SMS variants), audiences, status, and schedule.                                                 | View Marketing or Manage Campaigns                      |
| **get\_campaign\_performance**           | Get per-campaign performance metrics plus period totals with a prior-period comparison: revenue, spend, ROI, revenue per recipient, and order/click/open/send counts.           | View Marketing Analytics                                |
| **list\_segments**                       | List marketing segments/audiences for the team. Use to discover segment IDs or inspect the audiences included or excluded on a campaign.                                        | View Marketing, Manage Campaigns, or Manage Automations |
| **get\_segment**                         | Get full configuration for a segment/audience, including counts and the dynamic condition tree when applicable.                                                                 | View Marketing, Manage Campaigns, or Manage Automations |
| **list\_automations**                    | List automations with IDs, names, enabled state, category, step count, and step types. Filter by step type to find automations for a feature, such as Recover.                  | View Marketing or Manage Automations                    |
| **get\_automation**                      | Get full automation details including enabled state, category, timestamps, and step configuration.                                                                              | View Marketing or Manage Automations                    |
| **get\_automation\_performance**         | Get per-automation performance metrics plus period totals with a prior-period comparison: revenue, spend, ROI, revenue per recipient, and order/click/open/send counts.         | View Marketing Analytics                                |
| **get\_automation\_step\_configuration** | Resolve the linked configuration for a specific automation step — Recover scenarios and messaging, email subject and builder sections, or SMS content, prefix, and attachments. | View Marketing or Manage Automations                    |
| **get\_automation\_step\_performance**   | Get step-level automation performance for a metric family, such as Recover recovered revenue, reply rate, and conversion rate.                                                  | View Marketing Analytics                                |
| **get\_template**                        | Get an email or SMS marketing template by ID — subject lines, email builder sections, SMS content, prefix, attachments, and AI config.                                          | View Marketing, Manage Campaigns, or Manage Automations |

### Analytics

| Tool                                    | Description                                                                                                                                                                                                                                    | Required permission |
| --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
| **generate\_custom\_analytics\_report** | Generate a custom analytics report from a plain-English question. Returns immediately with a report ID and URL while the report is prepared; the finished report appears on your Redo analytics page and can be viewed or downloaded as a CSV. | Other               |
| **edit\_custom\_analytics\_report**     | Regenerate an existing report from a full replacement spec describing the desired metrics, dimensions, filters, and date range. The previous version stays available while the new one is prepared.                                            | Other               |
| **get\_custom\_analytics\_report**      | Get a report's current state — status (preparing, ready, or failed with an error message), title, requested question, columns, and report URL once ready. Use to poll after generating or editing a report.                                    | Other               |
| **list\_custom\_analytics\_reports**    | List your custom reports, most recent first, with ID, title, status, and columns. Supports searching by title or requested question.                                                                                                           | Other               |

### Discounts

| Tool                               | Description                                                                                                                                                                                                                 | Required permission                                                                                    |
| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| **get\_discount\_config**          | Get the reusable discount configuration — offer, code/prefix, provider, expiration, eligibility, usage limits, and stacking rules — for a discount ID returned by a campaign, automation, template, or generated-code tool. | View Products, View Marketing, Manage Campaigns, Manage Automations, Access Conversion, or View Orders |
| **get\_generated\_discount\_code** | Look up an issued discount code and its usage records: whether it was used, by which customer or order, when it expires, and what configuration it came from. Accepts a code ID or the code itself.                         | View Products, View Marketing, Manage Campaigns, Manage Automations, Access Conversion, or View Orders |

### Support

| Tool          | Description                                                                                        | Required permission |
| ------------- | -------------------------------------------------------------------------------------------------- | ------------------- |
| **ask\_redo** | Ask the Redo support AI any question about your account, settings, policies, or platform features. | —                   |
