# Get started with MCP templates

The <u>**Redox MCP server**</u> is an open, model-agnostic gateway that lets your technically sophisticated healthcare integration team manage, configure, monitor, and automate your Redox environment through any AI client you already trust. You can access the MCP server without downloading software, locking into a proprietary model, or giving up control over your data.

## Prerequisites

- Your Redox organization must be opted in to the MCP server to access it. [Learn how to enable AI features](/how-to-use-redox/enable-redox-ai-assistants-or-mcp-server).
- You must have installed the Redox MCP server with the AI agent of your choice. [Learn how to access the MCP server](/how-to-use-redox/access-the-redox-mcp-server).
- From time to time, you might need to [update the MCP server](https://docs.redoxengine.com/permalink/eEpltKPM3lrixU5QzOgcj/#update-mcp-server). Try that first if some of the prompts aren’t working for you. Updating allows you to access the latest version of our MCP server. 

## Get your Redox organization IDs and environment IDs

Most tasks require the related Redox organization ID and environment ID. 

- If you belong to <u>**one Redox organization**</u>, the MCP server pulls that organization name and ID based off your user information to continue its task. 
- If you belong to <u>**multiple Redox organizations**</u>, the agent prompts you with a list of organizations you belong to and asks which one it should operate in. 

The agent does the same with environment names and IDs after you’ve specified which organization to operate in. 

## Use MCP templates

Natural language prompts help you take direct action in your Redox environment. We provide several example prompts by category for you to get started using the Redox MCP server. 

You can use these prompts with any AI agent you choose. Replace any bracketed placeholders with real IDs, names, or values. _Make sure to test any configuration changes in a staging environment first and specify the environment in each prompt._ 

Talk to your Redox Account Manager with any questions.

### Redox organizations

Review the Redox organizations you belong to. 

| **Prompt to use** | **Purpose** |
| --- | --- |
| _What are my Redox organizations?_ | See Redox organization(s) and corresponding IDs. |

### Authentication

Manage authentication in your Redox environment.

| **Prompt to use** | **Purpose** |
| --- | --- |
| _Create a new OAuth API key in environment \[ID\] for \[your system name\]._ | Manage API credentials for environment access. |
| _List all OAuth API keys configured in environment \[ID\]._ | Review all API credentials for environment. |
| _Delete OAuth API key \[ID\] from environment \[ID\]._ | Manage API credentials for environment access. |

### Subscriptions

Manage sources, destination, and subscriptions in your Redox environment.

| **Prompt to use** | **Purpose** |
| --- | --- |
| _Create a new source in environment \[ID\] named \[X\] with data model \[PatientAdmin\]._ | Set up data pipelines (i.e., subscriptions). |
| _Create a new destination in environment \[ID\] pointed at endpoint \[URL\] for connected organization \[Y\]._ | Set up data pipelines (i.e., subscriptions). |
| _Show me all sources configured in environment \[ID\]._ | Review already configured assets for subscriptions. |
| _Update the endpoint URL for destination \[ID\] to \[new URL\] and verify it._ | Manage data pipeline (i.e., subscriptions). |
| _Using the \[Org A + EHR\] subscription as a template, set up an identical subscription for connected \[Org B\]._ | Copy configuration to set up a new subscription with a different connected organization. |

### Config modifiers, filters, and translation sets

Manage data operation assets (i.e., config modifiers, filters, translation sets) in your Redox environment.

> **Create a config modifier in the Redox dashboard**
>
> We have a dedicated <u>**Config Modifier Assistant**</u> to help you build a new config modifier schema. We recommend [setting up config modifiers](/how-to-use-redox/change-data-with-config-modifiers/set-up-config-modifiers) in the dashboard if you want AI assistance. 
>
> ![](https://images.ctfassets.net/cl3wt5ehhnlv/1sLhHwp9Ne6o4xkgwaJ8dr/507b4e6b1da16a3e13159a268443e40e/Config-modifier-assistant-button.png)

| **Operation type** | **Prompt to use** | **Purpose** |
| --- | --- | --- |
| Any | _Show me a client by client view of all config modifiers, translation sets, and subscription details for all connections._ | Audit your subscriptions. |
| Any | _Copy this \[asset\] and apply it to my new subscription._ | Duplicate config modifiers, filters, or translation sets from one connection and apply them to another without rebuilding from scratch. |
| Any | _Audit all config modifiers and translation sets created by a specific user._ | Audit your assets and users. |
| Any | _Generate an audit document that outlines all config modifiers, translation sets, and filters for a given connection._ | Audit your assets and connections. |
| Config modifier | _Duplicate config modifier \[X\] from subscription \[ID\] subscription and apply it to the \[Org B\] subscription in environment \[ID\]._ | Duplicate config modifiers across subscriptions. |
| Config modifier | _Restore the previous version of config modifier \[ID\]._ | Restore config modifiers across subscriptions. |
| Config modifier | _Pull all config modifiers in the staging environment \[ID\] between organization \[ID\] and organization \[ID\]._ | Audit assets for a specific subscription. |
| Filter | _Show me the filters currently applied to subscription \[ID\]._ | View filters at a glance. |
| Filter | _Create a filter on subscription \[ID\] that only passes through NewPatient and PatientUpdate event types._ | Control which events flow through a subscription. |
| Filter | _Update the filter on subscription \[ID\] to exclude events where \[field\] is null._ | Manage filters across subscriptions. |
| Translation set | _List all translation sets in environment \[ID\]._ | View translations at a glance. |
| Translation set | _Show me the current translation mappings for translation set \[ID\]._ | View translation mappings across subscriptions. |
| Translation set | _Add a translation to set \[ID\] to map value \[A\] to \[B\]._ | Edit and manage translation mappings across subscriptions. |
| Translation set | _Show me any new translations added to translation set \[ID\] since \[date\]._ | View changes to translation sets at a glance. |
| Translation set | _Update my translation table with these new facility mappings._ | Add or update values in translation sets conversationally. This removes the obstacle of navigating nested menus for routine maintenance tasks. |

### Asset promotion

Manage and audit how config modifiers, filters, and translation sets are promoted.

| **Prompt to use** | **Purpose** |
| --- | --- |
| _How does staging asset compare to production for my connection to this org?_ | Get a diff of your staging and production environments, then promote assets directly once you know the gaps, all in one conversation. |
| _Promote config modifier \[ID\] from staging environment \[ID\] to production environment \[ID\]._ | Promote validated assets from staging to production. |
| _Promote translation set \[ID\] from staging to production._ | Promote validated assets from staging to production. |
| _Compare the sources, destinations, config modifiers, and filters for subscription \[ID\] in staging vs. production and summarize any differences._ | Get a diff view of staging and production assets. |
| _Promote all assets (config modifiers, filters, translation sets) associated with subscription \[ID\] from staging \[ID\] to production \[ID\]._ | Promote validated assets from staging to production. |
| _For subscription \[ID\], retrieve all associated config modifiers in production and flag any that aren't on their latest version._ | View and compare asset versions. |

### Redox environments and user roles

| **Prompt to use** | **Purpose** |
| --- | --- |
| _List all members and their roles in environment \[ID\]._ | Review user access and roles across environments. |
| _Assign \[user email\] the role of \[role name\] in environment \[ID\]._ | Control user access and roles across environments. |
| _List any users that haven’t logged into the Redox dashboard in the past 14 days._ | Audit active users and manage access across environments. |
| _Pull the users and roles for org \[ID\] and filter by \[email domain\]._ | Audit active users and manage access across environments. |

### Alert rules

Monitor and set up alerts for traffic in your Redox environment. 

| **Prompt to use** | **Purpose** |
| --- | --- |
| _Create an alert rule in environment \[ID\] that fires when the error rate exceeds 5% on destination \[ID\]._ | Set up monitoring and notifications for pipeline activity. |
| _Show me all triggered alerts in environment \[ID\]._ | Review triggered alerts for preemptive monitoring or troubleshooting. |
| _Update alert rule \[ID\] to notify \[email\] instead of the current recipient._ | Update monitoring and notifications for pipeline activity. |

### Log search and log inspector

Monitor and troubleshoot traffic in your subscriptions.

| **Prompt to use** | **Purpose** |
| --- | --- |
| _Show me any failed logs for this subscription in the last 24 hours._ | Search and filter logs by connection, time range, or status to quickly surface errors and understand what happened without navigating the Redox dashboard. |
| _Search for failed logs on subscription \[source ID\] from the past 24 hours"._ | Investigate traffic errors. |
| _Find logs for patient MRN \[X\] sent through source \[ID\] in the last 7 days._ | Search payloads and metadata to investigate traffic. |
| _Run log inspector on log \[ID\] in environment \[ID\] and summarize what happened._ | Investigate and troubleshoot traffic errors. |
| _Run a log health analysis on the staging environment \[ID\] or organization \[ID\]._ | Audit traffic health in staging before moving to production. |

### Metrics, transactions, and visibility

| **Prompt to use** | **Purpose** |
| --- | --- |
| _How many active connections do I have and what events are they subscribed to?_ | Get an instant summary of your integration landscape (i.e., sources, destinations, subscriptions, and transaction volumes) without manually pulling reports. |
| _How many transactions did organization \[ID\] process last month, broken down by connection?_ | Retrieve transaction volumes and activity summaries. |
| _Give me a CSV export of transaction metrics for organization \[ID\] for Q1._ | Retrieve transaction volumes and activity summaries. |
| _Show me product-level metrics for organization \[ID\] over the past 30 days._ | Retrieve transaction volumes and activity summaries. |
