Skip to main content

RevenueCat MCP Tools Reference

Tools available through the RevenueCat MCP server, organized by category

AIAsk AIChatGPTClaude

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.

The tables below are generated from the RevenueCat API v2 specification 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

ToolAccessWhat it does
get-account-billingReadReturns the developer's own RevenueCat billing details — current plan, billing period, and tracked revenue.
get-appReadReturns the configuration of a single app.
get-project-ui-configReadReturns the paywall UI configuration for a project: fonts, colors, saved color and gradient presets, and custom variables.
list-account-billing-invoicesReadLists the invoices RevenueCat has charged this account — the developer's own RevenueCat bill, with amounts and payment status.
list-app-public-api-keysReadReturns 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-appsReadLists the apps in a project.
list-audit-logsReadLists 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-collaboratorsReadLists the people with access to a project, including the project owner, with each collaborator's email and role.
list-projectsReadLists all RevenueCat projects accessible with the provided API key.
create-appWriteCreates a new app inside a project and returns it.
create-projectWriteCreates 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-appWritePartially updates an app's name and/or store-specific details and returns the updated app.
update-project-ui-configWriteUpdates the paywall UI configuration for a project.

Products and prices

ToolAccessWhat it does
get-productReadReturns a single product from the project's catalog by its RevenueCat product id (prod...), not by its store SKU.
get-product-store-stateReadReturns live ProductStoreState data from the target store (App Store Connect, Google Play Store, RC Billing, or Test Store).
get-product-store-state-operationReadPolls the async operation created by set-product-store-state.
list-pricesReadList prices for a product.
list-product-offersReadList the introductory offers for a product (RC Billing only).
list-productsReadReturns 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.
archive-productWriteArchives a product, making it inactive in RevenueCat without touching the store.
create-productWriteRegisters a new product in the project's catalog for a given app and returns the created product.
create-product-pricesWriteConfigure prices for a product.
equalize-subscription-pricesWriteFills missing App Store subscription territory prices by applying Apple equalizations from the current price configured in base_territory.
set-product-store-stateWriteCreates or updates desired store metadata for a product and returns an async operation_id.
submit-products-to-storeWriteSubmits App Store products for review when each product is ready for submission.
unarchive-productWriteUnarchives a previously archived product, making it active again, and returns the updated product.
upload-product-store-state-screenshotWriteReserves an App Store Connect review screenshot slot and returns upload_operations.

Entitlements

ToolAccessWhat it does
get-entitlementReadReturns a single entitlement by id.
get-products-from-entitlementReadLists the products attached to an entitlement — the purchases that unlock it.
list-entitlementsReadLists all entitlements in a project — the levels of access customers unlock by purchasing the products attached to them.
archive-entitlementWriteArchives an entitlement, making it inactive, and returns the updated entitlement.
attach-products-to-entitlementWriteAttaches products to an entitlement so purchasing any of them unlocks it, and returns the updated entitlement.
create-entitlementWriteCreates a new entitlement.
detach-products-from-entitlementWriteDetaches products from an entitlement so purchasing them no longer unlocks it, and returns the updated entitlement.
unarchive-entitlementWriteUnarchives a previously archived entitlement, making it active again, and returns the updated entitlement.
update-entitlementWriteUpdates an entitlement's display_name — the only editable field — and returns the updated entitlement.

Offerings and Packages

ToolAccessWhat it does
get-offeringReadReturns a single offering by id.
get-offering-pricesReadGet the prices of all packages in an offering, grouped by package, for a given currency and country (defaults: USD / US).
list-offeringsReadReturns the list of offerings in a project.
list-packagesReadReturns the list of packages in an offering.
archive-offeringWriteArchives an offering, making it inactive so it is no longer returned by the SDK, and returns the updated offering.
attach-products-to-packageWriteAttaches products to a package and returns the updated package.
create-offeringWriteCreates a new offering.
create-packagesWriteCreates a new package for an offering.
delete-package-from-offeringWritePermanently deletes a package from its offering.
detach-products-from-packageWriteDetaches products from a package and returns the updated package.
unarchive-offeringWriteUnarchives a previously archived offering so the SDK serves it again, and returns the updated offering.
update-offeringWriteUpdates an offering and returns it; only the provided fields change.

Targeting and audiences

ToolAccessWhat it does
get-audienceReadReturns a single audience with its name and membership rules.
get-audience-filter-optionsReadReturns 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-ruleReadReturns 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-audiencesReadReturns all audiences in the project — saved customer segments defined by filter rules.
list-targeting-rulesReadLists targeting rules for a project, returning active rules before inactive rules.
create-audienceWriteCreates a new audience (a saved customer segment) from a name and membership rules, and returns it.
update-audienceWriteUpdates an audience's name and/or membership rules (partial update: only the fields provided change) and returns the updated audience.

Paywalls

ToolAccessWhat it does
get-paywallReadReturns a single paywall by id — the UI configuration built in the RevenueCat dashboard's paywall editor.
list-paywallsReadReturns the list of paywalls in a project — the UI configurations built in the RevenueCat dashboard's paywall editor.
publish-paywallWritePublishes the current draft of a paywall, making it live for production users immediately.
unpublish-paywallWriteUnpublishes a paywall, taking it out of production so it is no longer served to users.

Customers and subscriptions

ToolAccessWhat it does
get-customerReadReturns detailed customer information customer (attributes, entitlements, metadata).
get-customer-center-configReadReturns the Customer Center configuration for a customer.
get-subscriptionReadReturns a single subscription by its RevenueCat subscription id — no customer id needed.
list-customer-eventsReadReturns the customer's event history.
list-customersReadSearch for individual customers in the project by email, app user ID, or transaction / order identifiers.
list-purchasesReadReturns the customer's one-time (non-subscription) purchases: what was bought, its refund status, and the entitlements it unlocks.
list-subscriptionsReadReturns the customer's subscriptions across all stores; gives_access is the authoritative flag for whether the customer should have access to the associated entitlements.
list-virtual-currencies-balancesReadReturns the customer's virtual currency balances.
assign-customer-offeringWriteSets 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-entitlementWriteGrants a customer promotional access to an entitlement until expires_at, without a store purchase; as a side effect a promotional subscription is created.

Virtual Currencies

ToolAccessWhat it does
get-virtual-currencyReadReturns information about a virtual currency (name, description, product grants).
list-virtual-currenciesReadLists the virtual currencies available for the project.
archive-virtual-currencyWriteArchives a virtual currency, making it inactive, and returns the updated currency.
create-virtual-currencyWriteCreates a virtual currency in the project and returns the created currency.
unarchive-virtual-currencyWriteUnarchives a previously archived virtual currency, making it active again, and returns the updated currency.
update-virtual-currencyWriteUpdates an existing virtual currency identified by virtual_currency_code and returns the updated currency.

Charts, metrics, and experiments

ToolAccessWhat it does
get-benchmarksReadReturns 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-dataReadReturns time-series data for a specific chart.
get-chart-options-schemaReadGet LLM-friendly option schema for a chart.
get-experimentReadReturns the full configuration of a single experiment: status, variant offerings (offering_a = control), metrics, enrollment settings, and targeting.
get-experiment-resultsReadReturns per-variant performance data for an experiment, optionally filtered by platform, country, or exposure status.
get-overview-metricsReadProvides a summary of key project metrics for the last 28 days without needing to query individual charts.
get-revenue-metricReadReturns the total revenue for the project across all of its apps for the given inclusive date range.
list-experimentsReadReturns the project's experiments (A/B tests of offerings, prices, and paywalls), optionally filtered by status.

Integrations and webhooks

ToolAccessWhat it does
get-webhook-integrationReadReturns a single webhook integration by id: its destination URL and delivery filters (null values mean no filtering).
list-webhook-integrationsReadLists the webhook integrations configured for a project, each with its destination URL and delivery filters (null filter values mean no filtering).
create-webhook-integrationWriteCreates a webhook integration that starts delivering RevenueCat events to the given url; omitted/null filters mean all events, environments, and apps.
delete-webhook-integrationWritePermanently deletes a webhook integration and stops all event deliveries to its URL.
update-webhook-integrationWritePartially 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

ToolAccessWhat it does
list-sdk-feature-gatesReadLists 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-versionsReadLists SDK version distribution data for a project.

Paywall Editing

ToolAccessWhat it does
create-paywall-aiWriteStarts an async Paywall AI Editor task to create an unpublished RevenueCat paywall from a blank canvas, then returns a task ID.
edit-paywall-aiWriteStarts an async Paywall AI Editor task to update an existing RevenueCat paywall, then returns a task ID.
get-paywall-ai-taskReadChecks a Paywall AI Editor task returned by create-paywall-ai or edit-paywall-ai
render-paywall-screenshotRender a PNG screenshot of a RevenueCat paywall
Was this page helpful?