From 1be53539b2091c3257ec273e1105e61c420fc482 Mon Sep 17 00:00:00 2001 From: Engin Kurutepe Date: Wed, 26 Nov 2025 10:17:28 +0100 Subject: [PATCH 1/4] draft remove local MPC. do not PR yet --- docs/tools/mcp.mdx | 53 +++++++++++++------ .../best-practices-and-troubleshooting.mdx | 47 +++------------- docs/tools/mcp/overview.mdx | 51 ------------------ docs/tools/mcp/setup.mdx | 46 ++-------------- docs/tools/mcp/tools-reference.mdx | 2 +- docs/tools/mcp/usage-examples.mdx | 2 +- sidebars.ts | 2 +- static/llms.txt | 5 +- 8 files changed, 51 insertions(+), 157 deletions(-) delete mode 100644 docs/tools/mcp/overview.mdx diff --git a/docs/tools/mcp.mdx b/docs/tools/mcp.mdx index fdee36f4c..cec7d4508 100644 --- a/docs/tools/mcp.mdx +++ b/docs/tools/mcp.mdx @@ -8,35 +8,56 @@ hidden: false The RevenueCat MCP (Model Context Protocol) Server enables AI assistants to manage subscription apps, products, entitlements, and everything in-between without requiring direct dashboard access. This powerful tool provides 26 different capabilities for complete subscription management through natural language interactions. -## Getting Started +## What is MCP? + +[Model Context Protocol](https://modelcontextprotocol.io/) is a standard that allows AI assistants to securely access external tools and data sources. The RevenueCat MCP server acts as a bridge between AI assistants (like Claude, GPT-4, etc.) and the RevenueCat API, enabling natural language interactions with your subscription infrastructure. + +## Deployment + +The RevenueCat MCP server is available as a cloud-hosted service: + +**Best for:** + +- Team collaboration and shared access +- Production environments +- Individual developer use +- Integration with multiple AI assistants or applications +- Centralized, always-available service + +**Access:** `https://mcp.revenuecat.ai/mcp` -### 1. [Overview](./mcp/overview) -Learn what MCP is, explore deployment options, and understand the core features and capabilities of the RevenueCat MCP server. +## Core Features & Capabilities -### 2. [Setup](./mcp/setup) -Get your API keys and configure the MCP server for either cloud deployment or local VS Code/Cursor extension. +The MCP server provides 26 powerful tools for: -### 3. [Tools Reference](./mcp/tools-reference) +- **Project Management**: Access and view RevenueCat project details +- **App Management**: Create, read, update, and delete apps across multiple platforms (iOS, macOS, Android, Amazon, Stripe, RC Billing, Roku) +- **Product Management**: Manage subscription products and in-app purchases +- **Entitlement Management**: Control user access and permissions +- **Offering & Package Management**: Create and manage subscription offerings +- **Paywall Management**: Create and manage paywalls +- **Analytics Integration**: Built-in tracking for tool usage + +## Getting Started + +### 1. [Setup](./mcp/setup) +Get your API keys and configure the MCP server for your AI assistant. + +### 2. [Tools Reference](./mcp/tools-reference) Complete reference documentation for all 26 available tools, organized by category with detailed parameter tables. -### 4. [Usage Examples](./mcp/usage-examples) +### 3. [Usage Examples](./mcp/usage-examples) Natural language interaction examples and common usage patterns to help you get the most out of the MCP server. -### 5. [Best Practices & Troubleshooting](./mcp/best-practices-and-troubleshooting) +### 4. [Best Practices & Troubleshooting](./mcp/best-practices-and-troubleshooting) Security considerations, best practices, troubleshooting guides, and advanced usage patterns. ## Quick Start -Choose your deployment option: - -**Cloud Server**: Perfect for team collaboration and production use +**Cloud Server**: Perfect for team collaboration, production use, and individual development - Access: `https://mcp.revenuecat.ai/mcp` - Authentication: Bearer token with your RevenueCat API v2 key -**Local Extension**: Ideal for individual development -- Install from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=RevenueCat.revenuecat-mcp-extension) -- Configure with your API key directly in VS Code/Cursor - ## What You Can Do With natural language commands, you can: @@ -48,4 +69,4 @@ With natural language commands, you can: - **Generate Paywalls**: Build paywalls for your offerings - **Monitor Configuration**: Review and validate your subscription setup -Start with the [Overview](./mcp/overview) to understand the fundamentals, or jump to [Setup](./mcp/setup) if you're ready to begin configuration. \ No newline at end of file +Ready to get started? Jump to [Setup](./mcp/setup) to configure the MCP server for your AI assistant. \ No newline at end of file diff --git a/docs/tools/mcp/best-practices-and-troubleshooting.mdx b/docs/tools/mcp/best-practices-and-troubleshooting.mdx index b20687977..095f8ddbb 100644 --- a/docs/tools/mcp/best-practices-and-troubleshooting.mdx +++ b/docs/tools/mcp/best-practices-and-troubleshooting.mdx @@ -23,34 +23,10 @@ hidden: false - `$rc_lifetime` for lifetime purchases - `$rc_custom_*` for custom packages -### Workspace Organization (Local Extension) - -- **One workspace per project**: Keep different RevenueCat projects in separate workspaces -- **Environment separation**: Use different API keys for different environments -- **Documentation**: Keep your `mcp.json` structure documented for team members - ## Troubleshooting ### Common Issues -#### MCP Server Not Enabled (Local Extension) - -**Symptoms**: No responses from RevenueCat commands in chat -**Solution**: - -1. Go to **Cursor Settings → MCP** -2. Click **Enable** -3. Click **Refresh** - -#### MCP Server Disconnected - -**Symptoms**: Previously working commands stop responding -**Solution**: - -1. Go to **Cursor Settings → MCP** (for local extension) -2. Click **Refresh** -3. If issues persist, reload the window - #### API Key Issues **Symptoms**: Authentication errors or "unauthorized" responses @@ -59,38 +35,27 @@ hidden: false 1. Verify your API key is correct 2. Check key permissions (read vs write) 3. Ensure the key belongs to the correct project -4. For local extension: Re-run `RevenueCat: Set Project Secret Key` -5. For cloud server: Update your Authorization header - -#### Missing mcp.json (Local Extension) - -**Symptoms**: Extension doesn't work after setting API key -**Solution**: - -1. The extension should create `mcp.json` automatically -2. If missing, remove and re-add your API key -3. Check that the MCP server port is correctly configured +4. Update your Authorization header with the correct API key ### Debug Information For troubleshooting: -1. Check the VS Code Developer Console for debug logs (local extension) -2. Verify `mcp.json` contains the correct server configuration (local extension) -3. Test with simple commands like "Show me my project details" -4. Ensure API key has proper permissions in RevenueCat dashboard +1. Test with simple commands like "Show me my project details" +2. Ensure API key has proper permissions in RevenueCat dashboard +3. Check your AI assistant's MCP connection logs ## Security Considerations -- **Never commit `mcp.json`**: Always add it to `.gitignore` (local extension) - **Use environment-specific keys**: Don't use production keys in development - **Regular key rotation**: Change API keys periodically - **Team access**: Use separate keys for each team member when possible - **Monitor usage**: Regularly review API key usage in your RevenueCat dashboard +- **Secure storage**: Keep your API keys secure and never commit them to version control ## Error Handling -Both deployment options provide detailed error responses including: +The MCP server provides detailed error responses including: - Authentication errors for missing or invalid tokens - API errors with full RevenueCat API response details diff --git a/docs/tools/mcp/overview.mdx b/docs/tools/mcp/overview.mdx deleted file mode 100644 index 59c29aea3..000000000 --- a/docs/tools/mcp/overview.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: RevenueCat MCP Server Overview -sidebar_label: Overview -slug: overview -excerpt: AI-powered subscription management through natural language interactions -hidden: false ---- - -The RevenueCat MCP (Model Context Protocol) Server enables AI assistants to manage subscription apps, products, entitlements, and everything in-between without requiring direct dashboard access. This powerful tool provides 26 different capabilities for complete subscription management through natural language interactions. - -## What is MCP? - -[Model Context Protocol](https://modelcontextprotocol.io/) is a standard that allows AI assistants to securely access external tools and data sources. The RevenueCat MCP server acts as a bridge between AI assistants (like Claude, GPT-4, etc.) and the RevenueCat API, enabling natural language interactions with your subscription infrastructure. - -## Deployment Options - -The RevenueCat MCP server is available in two deployment configurations, each with the same core functionality but different setup and use cases: - -### Cloud MCP Server - -**Best for:** - -- Team collaboration and shared access -- Production environments -- Integration with multiple AI assistants or applications -- When you need a centralized, always-available service - -**Access:** `https://mcp.revenuecat.ai/mcp` - -### Local MCP Extension (VS Code/Cursor) - -**Best for:** - -- Individual developer use -- Local development and testing -- Quick setup and immediate use -- Integration with your existing Cursor/VS Code workflow - -**Install:** Available in the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=RevenueCat.revenuecat-mcp-extension) - -## Core Features & Capabilities - -Both deployment options provide identical functionality with 26 powerful tools for: - -- **Project Management**: Access and view RevenueCat project details -- **App Management**: Create, read, update, and delete apps across multiple platforms (iOS, macOS, Android, Amazon, Stripe, RC Billing, Roku) -- **Product Management**: Manage subscription products and in-app purchases -- **Entitlement Management**: Control user access and permissions -- **Offering & Package Management**: Create and manage subscription offerings -- **Paywall Management**: Create and manage paywalls -- **Analytics Integration**: Built-in tracking for tool usage \ No newline at end of file diff --git a/docs/tools/mcp/setup.mdx b/docs/tools/mcp/setup.mdx index 394335a3f..99c7edd56 100644 --- a/docs/tools/mcp/setup.mdx +++ b/docs/tools/mcp/setup.mdx @@ -2,7 +2,7 @@ title: RevenueCat MCP Server Setup sidebar_label: Setup slug: setup -excerpt: Configure RevenueCat MCP Server for cloud or local deployment +excerpt: Configure RevenueCat MCP Server for your AI assistant hidden: false --- @@ -12,7 +12,7 @@ import AddToCursor from '@site/src/components/AddToCursor'; RevenueCat MCP Server offers two authentication methods depending on your client: -- **OAuth Authentication**: Available for VSCode and Cursor - provides seamless authentication without managing API keys +- **OAuth Authentication**: Available for VS Code and Cursor - provides seamless authentication without managing API keys - **API v2 Secret Key**: Supported by all MCP clients - requires a RevenueCat API v2 secret key Choose the method that works best for your client setup. @@ -158,7 +158,7 @@ All MCP clients support API v2 secret key authentication. This method requires m #### Getting Your API Key 1. Open your [RevenueCat dashboard](https://app.revenuecat.com/) -2. Navigate to your project's **API Keys** page +2. Navigate to your project's **API Keys** page 3. **Create a new API v2 secret key** and copy it > **💡 Tip**: Create a dedicated API key for the MCP server to keep your credentials organized. @@ -171,43 +171,3 @@ All MCP clients support API v2 secret key authentication. This method requires m > **🔧 Third-Party Integration**: > If you'd like to integrate your services with RevenueCat MCP Server, please contact us at [RevenueCat Support](mailto:support@revenuecat.com) so we can set up OAuth clients for your application. - -## Local MCP Extension Setup - -### 1. Install Extension - -1. Open VS Code or Cursor -2. Go to Extensions marketplace -3. Search for "RevenueCat MCP" - > **⚠️ Visual Studio Marketplace**: - > - > This only works if your VS Code fork has access to the Visual Studio Marketplace. - > - > If not, you can install the extension manually by downloading the [VSIX file](https://drive.google.com/file/d/1VcyqirfdJtrAMuDnMTBkU8USCbdvMTMn/view?usp=share_link). -4. Click **Install** - -### 2. Configure Extension - -1. Open Command Palette (`Cmd+Shift+P` or `Ctrl+Shift+P`) -2. Run: **RevenueCat: Set Project Secret Key** -3. Paste your API key when prompted - -This creates an `mcp.json` file in your workspace with the MCP server configuration. - -> **🔒 Security**: Add `mcp.json` to your `.gitignore` to avoid committing your API credentials. - -### 3. Enable MCP in Cursor - -1. Go to **Cursor Settings → MCP** -2. Click the **Enable** button -3. Click the **Refresh** icon to activate the server - -## VS Code Extension Commands - -The local extension provides additional VS Code commands for key management: - -| Command | Description | -| ------------------------------------------ | ------------------------------------- | -| `RevenueCat: Set Project Secret Key` | Set or update your API key | -| `RevenueCat: Remove Project Secret Key` | Delete your stored API key | -| `RevenueCat: Show your project secret key` | Display your current API key (masked) | diff --git a/docs/tools/mcp/tools-reference.mdx b/docs/tools/mcp/tools-reference.mdx index 75949ad1d..a2f723844 100644 --- a/docs/tools/mcp/tools-reference.mdx +++ b/docs/tools/mcp/tools-reference.mdx @@ -6,7 +6,7 @@ excerpt: Complete reference for all 26 RevenueCat MCP server tools hidden: false --- -Both deployment options provide the same 26 tools organized into functional categories: +The RevenueCat MCP server provides 26 tools organized into functional categories: ## Project Tools diff --git a/docs/tools/mcp/usage-examples.mdx b/docs/tools/mcp/usage-examples.mdx index 313ed5cd2..dfa8655d0 100644 --- a/docs/tools/mcp/usage-examples.mdx +++ b/docs/tools/mcp/usage-examples.mdx @@ -6,7 +6,7 @@ excerpt: Natural language interaction examples with RevenueCat MCP server hidden: false --- -Both deployment options support the same natural language interactions. Here are common examples: +The RevenueCat MCP server supports natural language interactions. Here are common examples: ## Basic Project Information diff --git a/sidebars.ts b/sidebars.ts index 3064ff884..aeaa49a9d 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -896,7 +896,7 @@ const aiToolsCategory = Category({ items: [ SubCategory({ label: "RevenueCat MCP Server", - slug: "mcp/overview", + slug: "mcp", itemsPathPrefix: "mcp/", items: [ Page({ slug: "setup" }), diff --git a/static/llms.txt b/static/llms.txt index e25c29b90..05d67d4ef 100644 --- a/static/llms.txt +++ b/static/llms.txt @@ -63,9 +63,8 @@ The prefix for the URL paths is: https://www.revenuecat.com/docs ## RevenueCat MCP Server (Model Context Protocol) -- /tools/mcp - Complete MCP server overview and setup guide -- /tools/mcp/overview - What MCP is and deployment options (cloud vs local) -- /tools/mcp/setup - Configure MCP server for cloud or local VS Code/Cursor extension +- /tools/mcp - Complete MCP server overview, what MCP is, and deployment information +- /tools/mcp/setup - Configure MCP server for your AI assistant - /tools/mcp/tools-reference - Complete reference for all 26 MCP server tools - /tools/mcp/usage-examples - Natural language interaction examples with MCP - /tools/mcp/best-practices-and-troubleshooting - Security and troubleshooting guide From 934067430904fcc68954b08596698a2af3e0880f Mon Sep 17 00:00:00 2001 From: Engin Kurutepe Date: Thu, 22 Jan 2026 11:51:07 +0100 Subject: [PATCH 2/4] add a section about OAuth common issues --- .../mcp/best-practices-and-troubleshooting.mdx | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/tools/mcp/best-practices-and-troubleshooting.mdx b/docs/tools/mcp/best-practices-and-troubleshooting.mdx index 095f8ddbb..080fea75b 100644 --- a/docs/tools/mcp/best-practices-and-troubleshooting.mdx +++ b/docs/tools/mcp/best-practices-and-troubleshooting.mdx @@ -27,6 +27,23 @@ hidden: false ### Common Issues + +#### OAuth Issues + +If you're using OAuth to authenticate with the RevenueCat MCP, you may encounter the following issues: + +**Unknown MCP Client** + +**Symptoms**: OAuth flow fails with an error indicating the client is not recognized +**Cause**: RevenueCat uses a simplified public client registration flow and does not allow automatic client additions. Your MCP client may not be registered with our OAuth server. +**Solution**: Contact [RevenueCat support](https://app.revenuecat.com/settings/support) with your client details so we can allowlist your MCP client. + +**Outdated Redirect URIs** + +**Symptoms**: OAuth flow fails during the redirect step, or you receive an error about invalid redirect URI +**Cause**: MCP clients occasionally update their redirect URIs, and our OAuth server configuration may not yet reflect these changes. +**Solution**: Contact [RevenueCat support](https://app.revenuecat.com/settings/support) with the details of your MCP client and the expected redirect URI so we can update our configuration. + #### API Key Issues **Symptoms**: Authentication errors or "unauthorized" responses From 7575c26a7a7c01d972ae8c2ede8ba64ae80f91ba Mon Sep 17 00:00:00 2001 From: Engin Kurutepe Date: Thu, 22 Jan 2026 13:44:47 +0100 Subject: [PATCH 3/4] little fixes --- docs/welcome/overview.mdx | 2 +- static/llms.txt | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/welcome/overview.mdx b/docs/welcome/overview.mdx index 6f62fa398..6cf08a550 100644 --- a/docs/welcome/overview.mdx +++ b/docs/welcome/overview.mdx @@ -100,7 +100,7 @@ For AI assistants, see our [llms.txt file](/llms.txt) for structured access to k diff --git a/static/llms.txt b/static/llms.txt index 05d67d4ef..6e41100c1 100644 --- a/static/llms.txt +++ b/static/llms.txt @@ -63,8 +63,8 @@ The prefix for the URL paths is: https://www.revenuecat.com/docs ## RevenueCat MCP Server (Model Context Protocol) -- /tools/mcp - Complete MCP server overview, what MCP is, and deployment information -- /tools/mcp/setup - Configure MCP server for your AI assistant +- /tools/mcp - Overview of RevenueCat MCP server for AI-powered subscription management +- /tools/mcp/setup - Configure cloud MCP server for your AI assistant (OAuth or API key auth) - /tools/mcp/tools-reference - Complete reference for all 26 MCP server tools - /tools/mcp/usage-examples - Natural language interaction examples with MCP - /tools/mcp/best-practices-and-troubleshooting - Security and troubleshooting guide From 90ea4812b38c55e2e245d2afbe18361843e07cf3 Mon Sep 17 00:00:00 2001 From: Engin Kurutepe Date: Thu, 22 Jan 2026 13:59:37 +0100 Subject: [PATCH 4/4] Add redirect from /tools/mcp/overview to /tools/mcp --- src/redirects/redirects.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/redirects/redirects.ts b/src/redirects/redirects.ts index dc5b1fba5..496b65a87 100644 --- a/src/redirects/redirects.ts +++ b/src/redirects/redirects.ts @@ -1515,6 +1515,10 @@ const redirects = { to: "/tools/targeting", from: "/targeting.html", }, + { + to: "/tools/mcp", + from: "/tools/mcp/overview", + }, { to: "/projects/authentication", from: "/authentication",