RevenueCat MCP Tools Reference
Tools available through the RevenueCat MCP server, organized by category
This page lists the tools the RevenueCat MCP server exposes to AI assistants, organized by category. For setup instructions, see MCP Server Setup; for example prompts, see Usage Examples.
Your agent calls these tools on your behalf when you ask it to configure or inspect RevenueCat. Read tools only fetch data; Write tools create, change, or delete configuration. Access follows your RevenueCat account permissions. Scopes lists the permissions the tool needs; a tool only appears in your MCP client when your credentials grant all of them.
The tables below are generated from the RevenueCat MCP server and cover the generally available tool set. The tool set evolves with the platform, so your MCP client is the source of truth for what it can call once connected.
Projects and apps
| Tool | Access | Scopes | What it does |
|---|---|---|---|
get-account-billing | Read | account:billing:read | Returns the developer's own RevenueCat billing details — current plan, billing period, and tracked revenue. |
get-app | Read | project_configuration:apps:read | Returns the configuration of a single app. |
get-project-ui-config | Read | project_configuration:projects:read | Returns the paywall UI configuration for a project: fonts, colors, saved color and gradient presets, and custom variables. |
get-refund-request-preferences | Read | project_configuration:apps:read | Returns the Refund Control preferences configured for a project, including the default handling preference and any audience-specific policies in priority order. |
list-account-billing-invoices | Read | account:billing:read | Lists the invoices RevenueCat has charged this account — the developer's own RevenueCat bill, with amounts and payment status. |
list-app-public-api-keys | Read | project_configuration:apps:read | Returns the public (SDK) API keys of an app — the keys embedded in client apps to initialize the RevenueCat SDK, not secret server-side keys. |
list-app-subscription-groups | Read | project_configuration:products:read | Lists the subscription groups configured in App Store Connect for an App Store app, each with its subscription products (store_identifier, name, ISO 8601 duration, status). |
list-apps | Read | project_configuration:apps:read | Lists the apps in a project. |
list-audit-logs | Read | project_configuration:audit_logs:read | Lists a project's audit logs — records of configuration changes made through the dashboard or API (who changed what and when), not customer purchase activity. |
list-collaborators | Read | project_configuration:collaborators:read | Lists the people with access to a project, including the project owner, with each collaborator's email and role. |
list-projects | Read | project_configuration:projects:read | Lists all RevenueCat projects accessible with the provided API key. |
validate-app-credentials | Read | project_configuration:apps:read | Checks one saved App Store or Google Play credential set for an app and returns each validation check. |
create-app | Write | project_configuration:apps:read_write | Creates a new app inside a project and returns it. |
create-project | Write | project_configuration:projects:read_write | Creates a new RevenueCat project — the top-level container that apps, products, entitlements, and offerings live under — and returns it; use the returned id with create-app to add apps. |
update-app | Write | project_configuration:apps:read_write | Partially updates an app's name and/or store-specific details and returns the updated app. |
update-project-ui-config | Write | project_configuration:projects:read_write | Updates the paywall UI configuration for a project. |
Products and prices
| Tool | Access | Scopes | What it does |
|---|---|---|---|
get-product | Read | project_configuration:products:read | Returns a single product from the project's catalog by its RevenueCat product id (prod...), not by its store SKU. |
get-product-store-state | Read | project_configuration:products:read | Returns live ProductStoreState data from the target store (App Store Connect, Google Play Store, RC Billing, or Test Store). |
get-product-store-state-operation | Read | project_configuration:products:read | Deprecated. |
get-product-store-state-plan | Read | project_configuration:products:read | Returns the full product store state plan. |
list-product-store-state-plans | Read | project_configuration:products:read | Lists product store state plans for a project. |
list-products | Read | project_configuration:products:read | Returns the in-app purchase and subscription products registered in a project's app catalog (store SKUs) — not to be confused with list-projects, which lists the projects on the account. |
apply-product-store-state-plan | Write | project_configuration:products:read_write | Queues asynchronous apply for a planned or retryable product store state plan. |
archive-product | Write | project_configuration:products:read_write | Archives a product, making it inactive in RevenueCat without touching the store. |
create-product | Write | project_configuration:products:read_write | the created product — this only registers a product with RevenueCat; it does not create anything in the underlying store. |
create-product-prices | Write | project_configuration:products:read_write | Deprecated. |
create-product-store-state-plan | Write | project_configuration:products:read_write | Creates a draft plan to create or update products in RevenueCat and the app stores from one or more desired product store states. |
create-product-store-state-review-screenshot | Write | project_configuration:products:read_write | Stages an App Store review screenshot (PNG or JPEG, sent base64-encoded in file_data_base64) for an App Store app and returns it. |
discard-product-store-state-plan | Write | project_configuration:products:read_write | Discards a product store state plan that is no longer needed and is in a discardable state. |
equalize-subscription-prices | Write | project_configuration:products:read_write | Deprecated. |
plan-product-store-state-plan | Write | project_configuration:products:read_write | Queues asynchronous planning for a draft or replannable product store state plan. |
set-product-store-state | Write | project_configuration:products:read_write | Deprecated. |
submit-products-to-store | Write | project_configuration:products:read_write | Submits App Store products for review when each product is ready for submission. |
unarchive-product | Write | project_configuration:products:read_write | Unarchives a previously archived product, making it active again, and returns the updated product. |
update-product | Write | project_configuration:products:read_write | Update a product in the project's catalog. |
update-product-store-state-plan | Write | project_configuration:products:read_write | Replaces all desired states in an editable product store state plan and moves it back to draft status. |
upload-product-store-state-screenshot | Write | project_configuration:products:read_write | Deprecated. |
Entitlements
| Tool | Access | Scopes | What it does |
|---|---|---|---|
get-entitlement | Read | project_configuration:entitlements:read | Returns a single entitlement by id. |
get-products-from-entitlement | Read | project_configuration:entitlements:read | Lists the products attached to an entitlement — the purchases that unlock it. |
list-entitlements | Read | project_configuration:entitlements:read | Lists all entitlements in a project — the levels of access customers unlock by purchasing the products attached to them. |
archive-entitlement | Write | project_configuration:entitlements:read_write | Archives an entitlement, making it inactive, and returns the updated entitlement. |
attach-products-to-entitlement | Write | project_configuration:entitlements:read_write | Attaches products to an entitlement so purchasing any of them unlocks it, and returns the updated entitlement. |
create-entitlement | Write | project_configuration:entitlements:read_write | Creates a new entitlement. |
detach-products-from-entitlement | Write | project_configuration:entitlements:read_write | Detaches products from an entitlement so purchasing them no longer unlocks it, and returns the updated entitlement. |
unarchive-entitlement | Write | project_configuration:entitlements:read_write | Unarchives a previously archived entitlement, making it active again, and returns the updated entitlement. |
update-entitlement | Write | project_configuration:entitlements:read_write | Updates an entitlement's display_name — the only editable field — and returns the updated entitlement. |
Offerings and Packages
| Tool | Access | Scopes | What it does |
|---|---|---|---|
get-offering | Read | project_configuration:offerings:read | Returns a single offering by id. |
get-offering-prices | Read | project_configuration:offerings:readproject_configuration:packages:readproject_configuration:products:read | Get the prices of all packages in an offering, grouped by package, for a given currency and country (defaults: USD / US). |
list-offerings | Read | project_configuration:offerings:read | Returns the list of offerings in a project. |
list-packages | Read | project_configuration:packages:read | Returns the list of packages in an offering. |
archive-offering | Write | project_configuration:offerings:read_write | Archives an offering, making it inactive so it is no longer returned by the SDK, and returns the updated offering. |
attach-products-to-package | Write | project_configuration:packages:read_write | Attaches products to a package and returns the updated package. |
create-offering | Write | project_configuration:offerings:read_write | Creates a new offering. |
create-packages | Write | project_configuration:packages:read_write | Creates a new package for an offering. |
delete-package-from-offering | Write | project_configuration:packages:read_write | Permanently deletes a package from its offering. |
detach-products-from-package | Write | project_configuration:packages:read_write | Detaches products from a package and returns the updated package. |
duplicate-offering | Write | project_configuration:offerings:read_writeproject_configuration:packages:read_write | Duplicates an offering and its related entities into a new, non-current offering in the same project: - Packages (attaching the same existing products, not creating new products). |
unarchive-offering | Write | project_configuration:offerings:read_write | Unarchives a previously archived offering so the SDK serves it again, and returns the updated offering. |
update-offering | Write | project_configuration:offerings:read_write | Updates an offering and returns it; only the provided fields change. |
Targeting and audiences
| Tool | Access | Scopes | What it does |
|---|---|---|---|
get-audience | Read | audiences:audiences:read | Returns a single audience with its name and membership rules. |
get-audience-filter-options | Read | audiences:audiences:read | Returns the known values for audience rule fields whose options are derived from the project's data, such as attribution fields and custom attributes. |
get-targeting-rule | Read | project_configuration:targeting_rules:read | Returns one targeting rule in a project by targeting_rule_id, including its state, display name, offering, conditions, audience, schedule, and placement overrides when present. |
list-audiences | Read | audiences:audiences:read | Returns all audiences in the project — saved customer segments defined by filter rules. |
list-targeting-rules | Read | project_configuration:targeting_rules:read | Lists targeting rules for a project, returning active rules before inactive rules. |
preview-audience | Read | audiences:audiences:read | Returns matching customers without creating an audience. |
create-audience | Write | audiences:audiences:read_write | Creates a new audience (a saved customer segment) from a name and membership rules, and returns it. |
create-targeting-rule | Write | project_configuration:targeting_rules:read_write | Creates a targeting rule for a project. |
delete-targeting-rule | Write | project_configuration:targeting_rules:read_write | Deletes one targeting rule from a project. |
update-audience | Write | audiences:audiences:read_write | Updates an audience's name and/or membership rules (partial update: only the fields provided change) and returns the updated audience. |
update-targeting-rule | Write | project_configuration:targeting_rules:read_write | Updates a targeting rule. |
Paywalls
| Tool | Access | Scopes | What it does |
|---|---|---|---|
get-paywall | Read | project_configuration:offerings:read | Returns a single paywall by id — the UI configuration built in the RevenueCat dashboard's paywall editor. |
get-paywall-ai-task | Read | project_configuration:offerings:read_writeproject_configuration:projects:read | Checks a Paywall AI Editor task returned by create-paywall-ai or edit-paywall-ai. |
list-paywalls | Read | project_configuration:offerings:read | Returns the list of paywalls in a project — the UI configurations built in the RevenueCat dashboard's paywall editor. |
render-paywall-screenshot | Read | project_configuration:offerings:readproject_configuration:projects:read | Render a screenshot of a RevenueCat paywall. |
attach-offering-to-paywall | Write | project_configuration:offerings:read_write | Attaches an offering to a paywall so the paywall is served for that offering, and returns the updated paywall. |
create-paywall-ai | Write | project_configuration:offerings:read_writeproject_configuration:projects:read | Starts an async Paywall AI Editor task to create an unpublished RevenueCat paywall from a blank canvas, then returns a task ID. |
detach-offering-from-paywall | Write | project_configuration:offerings:read_write | Detaches the offering from a paywall and returns the updated paywall. |
duplicate-paywall | Write | project_configuration:offerings:read_writeproject_configuration:packages:read_write | Duplicates an existing paywall into a new, unpublished paywall in the same project. |
edit-paywall-ai | Write | project_configuration:offerings:read_writeproject_configuration:projects:read | Starts an async Paywall AI Editor task to update an existing RevenueCat paywall, then returns a task ID. |
publish-paywall | Write | project_configuration:offerings:read_write | Publishes the current draft of a paywall, making it live for production users immediately. |
unpublish-paywall | Write | project_configuration:offerings:read_write | Unpublishes a paywall, taking it out of production so it is no longer served to users. |
Customers and subscriptions
| Tool | Access | Scopes | What it does |
|---|---|---|---|
get-customer | Read | customer_information:customers:read | Returns detailed customer information customer (attributes, entitlements, metadata). |
get-customer-center-config | Read | customer_information:customers:read | Returns the Customer Center configuration for a customer. |
get-subscription | Read | customer_information:subscriptions:read | Returns a single subscription by its RevenueCat subscription id — no customer id needed. |
list-customer-events | Read | customer_information:customers:read | Returns the customer's event history. |
list-customers | Read | customer_information:customers:read | Search for individual customers in the project by email, app user ID, or transaction / order identifiers. |
list-purchases | Read | customer_information:purchases:read | Returns the customer's one-time (non-subscription) purchases: what was bought, its refund status, and the entitlements it unlocks. |
list-subscriptions | Read | customer_information:subscriptions:read | Returns the customer's subscriptions across all stores; gives_access is the authoritative flag for whether the customer should have access to the associated entitlements. |
assign-customer-offering | Write | project_configuration:offerings:readcustomer_information:customers:read_write | Sets a per-customer offering override, so this customer's app is served the given offering as its current offering instead of the one it would otherwise display. |
grant-customer-entitlement | Write | customer_information:customers:read_write | Grants a customer promotional access to an entitlement until expires_at, without a store purchase; as a side effect a promotional subscription is created. |
In-App Currencies
| Tool | Access | Scopes | What it does |
|---|---|---|---|
get-virtual-currency | Read | project_configuration:virtual_currencies:read | Returns information about an in-app currency (virtual currency): name, description, and product grants. |
list-virtual-currencies | Read | project_configuration:virtual_currencies:read | Lists the in-app currencies (virtual currencies) available for the project. |
list-virtual-currencies-balances | Read | customer_information:purchases:read | Returns the customer's in-app currency (virtual currency) balances. |
archive-virtual-currency | Write | project_configuration:virtual_currencies:read_write | Archives an in-app currency (virtual currency), making it inactive, and returns the updated currency. |
create-virtual-currency | Write | project_configuration:virtual_currencies:read_write | Creates an in-app currency (virtual currency) in the project and returns the created currency. |
unarchive-virtual-currency | Write | project_configuration:virtual_currencies:read_write | Unarchives a previously archived in-app currency (virtual currency), making it active again, and returns the updated currency. |
update-virtual-currency | Write | project_configuration:virtual_currencies:read_write | Updates an existing in-app currency (virtual currency) identified by virtual_currency_code and returns the updated currency. |
Charts, metrics, and experiments
| Tool | Access | Scopes | What it does |
|---|---|---|---|
get-benchmarks | Read | charts_metrics:benchmarks:read | Returns RevenueCat benchmark comparisons for every app in a project (or a single app when app_id is supplied), across the supported monetization metrics (realized LTV, trial conversion, initial conversion, conversion to paying, monthly churn, refund rate). |
get-chart-data | Read | charts_metrics:charts:read | Returns time-series data for a specific chart. |
get-chart-options-schema | Read | charts_metrics:charts:read | Get LLM-friendly option schema for a chart. |
get-experiment | Read | project_configuration:experiments:read | Returns the full configuration of a single experiment: status, variant offerings (offering_a = control), metrics, enrollment settings, and targeting. |
get-experiment-results | Read | charts_metrics:experiment_results:read | Returns per-variant performance data for an experiment, optionally filtered by platform, country, or paywall view status. |
get-overview-metrics | Read | charts_metrics:overview:read | Provides a summary of key project metrics for the last 28 days without needing to query individual charts. |
get-revenue-metric | Read | charts_metrics:overview:read | Returns the total revenue for the project across all of its apps for the given inclusive date range. |
list-chart-annotations | Read | charts_metrics:charts:read | Lists a project's chart annotations — notes marking events that may explain a change in the data — optionally filtered by start_date / end_date. |
list-experiments | Read | project_configuration:experiments:read | Returns the project's experiments (A/B tests of offerings, prices, and paywalls), optionally filtered by status. |
create-chart-annotation | Write | charts_metrics:charts:read_write | Creates a chart annotation marking an event that may explain a change in the data (an app release, a price change, a marketing push). |
create-experiment | Write | project_configuration:experiments:read_write | Creates a draft experiment. |
delete-chart-annotation | Write | charts_metrics:charts:read_write | Deletes a chart annotation. |
pause-experiment | Write | project_configuration:experiments:read_write | Pauses a running experiment and returns the updated experiment. |
resume-experiment | Write | project_configuration:experiments:read_write | Resumes a paused experiment and returns the updated experiment. |
start-experiment | Write | project_configuration:experiments:read_write | Starts a draft experiment and returns the updated experiment. |
stop-experiment | Write | project_configuration:experiments:read_write | Permanently stops a running or paused experiment and returns the updated experiment. |
update-chart-annotation | Write | charts_metrics:charts:read_write | Updates a chart annotation. |
update-experiment | Write | project_configuration:experiments:read_write | Partially updates an experiment: omitted fields remain unchanged. |
Integrations and webhooks
| Tool | Access | Scopes | What it does |
|---|---|---|---|
get-webhook-integration | Read | project_configuration:integrations:read | Returns a single webhook integration by id: its destination URL and delivery filters (null values mean no filtering). |
list-webhook-integrations | Read | project_configuration:integrations:read | Lists the webhook integrations configured for a project, each with its destination URL and delivery filters (null filter values mean no filtering). |
create-webhook-integration | Write | project_configuration:integrations:read_write | Creates a webhook integration that starts delivering RevenueCat events to the given url; omitted/null filters mean all events, environments, and apps. |
delete-webhook-integration | Write | project_configuration:integrations:read_write | Permanently deletes a webhook integration and stops all event deliveries to its URL. |
update-webhook-integration | Write | project_configuration:integrations:read_write | Partially updates a webhook integration and returns it: only the fields you send change, and sending null on a nullable field clears its filter. |
SDK compatibility
| Tool | Access | Scopes | What it does |
|---|---|---|---|
list-sdk-feature-gates | Read | project_configuration:sdk_compatibility:read | Lists SDK feature gates for a project, including minimum SDK requirements and whether each gate should be shown in the project's SDK compatibility table. |
list-sdk-versions | Read | project_configuration:sdk_compatibility:read | Lists SDK version distribution data for a project. |
IAM
| Tool | Access | Scopes | What it does |
|---|---|---|---|
get-iam-authentication-method | Read | iam:authentication_methods:read | Returns one authentication method by id, with its type-specific configuration. |
get-iam-settings | Read | iam:settings:read | Returns the IAM migration mode of the project. |
list-iam-authentication-methods | Read | iam:authentication_methods:read | Lists the authentication methods configured for the project (email OTP, magic link, OIDC, Google, Apple, Facebook, Firebase). |
create-iam-authentication-method | Write | iam:authentication_methods:read_write | Adds an authentication method that customers can use to sign in to the project's apps. |
delete-iam-authentication-method | Write | iam:authentication_methods:read_write | Permanently deletes an authentication method. |
update-iam-authentication-method | Write | iam:authentication_methods:read_write | Partially updates an authentication method and returns it: only the fields you send change, and null clears an optional field. |
update-iam-settings | Write | iam:settings:read_write | Sets the IAM migration mode of the project and returns the settings. |
Paywall Editing
| Tool | Access | What it does |
|---|---|---|
create-paywall-ai | Write | Starts an async Paywall AI Editor task to create an unpublished RevenueCat paywall from a blank canvas, then returns a task ID. |
edit-paywall-ai | Write | Starts an async Paywall AI Editor task to update an existing RevenueCat paywall, then returns a task ID. |
get-paywall-ai-task | Read | Checks a Paywall AI Editor task returned by create-paywall-ai or edit-paywall-ai |
render-paywall-screenshot | Render a PNG screenshot of a RevenueCat paywall |
Was this page helpful?