Skip to content

QUICKSTART.md

Latest commit

 

History

History
241 lines (167 loc) · 5.2 KB

QUICKSTART.md

File metadata and controls

241 lines (167 loc) · 5.2 KB

Quick Start Guide

Get started with MCP Server Creem in 5 minutes!

Prerequisites

  • Node.js 18 or higher
  • A Creem.io account
  • Claude Desktop (or another MCP client)

Step 1: Get Your Creem API Key

  1. Visit Creem Dashboard
  2. Click "Developers" in the top navigation
  3. Click the eye icon to reveal your API key
  4. Copy your API key (starts with creem_)

Step 2: Install MCP Server Creem

Option A: Install from npm (Coming Soon)

npm install -g mcp-server-creem

Option B: Install from Source

# Clone the repository
git clone https://github.com/Selenium39/mcp-server-creem.git
cd mcp-server-creem

# Install dependencies
npm install

# Build the project
npm run build

Step 3: Configure Claude Desktop

Find Your Config File

macOS:

~/Library/Application Support/Claude/claude_desktop_config.json

Windows:

%APPDATA%\Claude\claude_desktop_config.json

Linux:

~/.config/Claude/claude_desktop_config.json

Add MCP Server Configuration

Open the config file and add:

{
  "mcpServers": {
    "creem": {
      "command": "node",
      "args": [
        "/absolute/path/to/mcp-server-creem/build/index.js"
      ],
      "env": {
        "CREEM_API_KEY": "your-creem-api-key-here",
        "CREEM_TEST_MODE": "true"
      }
    }
  }
}

Important: Replace /absolute/path/to/mcp-server-creem with the actual path where you cloned the repository.

Example (macOS):

{
  "mcpServers": {
    "creem": {
      "command": "node",
      "args": [
        "/Users/yourname/projects/mcp-server-creem/build/index.js"
      ],
      "env": {
        "CREEM_API_KEY": "creem_test_abc123xyz789",
        "CREEM_TEST_MODE": "true"
      }
    }
  }
}

Step 4: Restart Claude Desktop

Close and reopen Claude Desktop completely.

Step 5: Verify Installation

In Claude Desktop, try asking:

"Can you list my Creem products?"

Claude should respond with a list of products from your Creem account.

Your First Actions

Create a Product

Ask Claude:

"Create a new product in Creem called 'Pro Plan' for $29 per month"

Create a Checkout Session

Ask Claude:

"Create a checkout session for the Pro Plan product"

Claude will provide a checkout URL that you can share with customers.

View Customer Information

Ask Claude:

"Show me my Creem customers"

Test Mode

The configuration above uses test mode (CREEM_TEST_MODE: "true"):

✅ Safe to experiment
✅ No real charges
✅ Use test card: 4242 4242 4242 4242
✅ Same functionality as production

Switch to Production

When ready to go live:

  1. Get your production API key from Creem Dashboard
  2. Update your config: 
    {
  "CREEM_API_KEY": "creem_live_your_production_key",
  "CREEM_TEST_MODE": "false"
}
  3. Restart Claude Desktop

⚠️ Warning: Production mode processes real payments!

Common Use Cases

1. Create and Sell a Product

You: "Create a one-time product called 'Premium eBook' for $49"
Claude: [Creates product]

You: "Create a checkout for that product"
Claude: [Returns checkout URL]

Share the URL with customers → They pay → You get paid! 💰

2. Manage Subscriptions

You: "Show me active subscriptions"
Claude: [Lists subscriptions]

You: "Cancel subscription sub_abc123"
Claude: [Cancels subscription]

3. Generate Customer Portal Links

You: "Generate a customer portal link for customer cust_xyz789"
Claude: [Returns portal URL]

Share the URL → Customer can manage their own subscription

Next Steps

Troubleshooting

Server Not Starting?

  1. Check your API key is correct
  2. Verify the path in args is absolute and correct
  3. Check Node.js version: node --version (should be 18+)
  4. Rebuild: npm run build in the project directory

"Invalid API Key" Error?

  1. Verify you copied the correct API key from Creem Dashboard
  2. Check you're using the right mode (test vs production)
  3. Test mode keys start with creem_test_
  4. Production keys start with creem_live_

Tools Not Appearing?

  1. Restart Claude Desktop completely
  2. Check the config file syntax is valid JSON
  3. Verify the command and args paths are correct
  4. Check Claude Desktop logs for errors

Still Having Issues?

What's Next?

Once you're comfortable with the basics:

  1. Set up webhooks to automate customer provisioning
  2. Implement license keys for software distribution
  3. Create discount codes for marketing campaigns
  4. Build seat-based billing for team products
  5. Explore subscription upgrades for tiered pricing

Happy selling! 🚀