Skip to content

SchematicHQ/schematic-mcp

Repository files navigation

Schematic MCP Server

An MCP server that connects AI assistants to Schematic -- the platform for managing billing, plans, features, and entitlements.

Use this server to let Claude, Cursor, or any MCP-compatible client look up companies, manage plan entitlements, set overrides, create features, and more -- all through natural language.

Quick Start

Prerequisites

  1. Get your Schematic API key: Sign up for a Schematic account and get your API key from the Schematic dashboard.

Installation

Option 1: Using Claude CLI (Recommended)

  1. Install the package from npm:

    npm i @schematichq/schematic-mcp
  2. Add the MCP server to Claude:

    claude mcp add --transport stdio --scope project schematic --env SCHEMATIC_API_KEY=your-api-key-here -- npx @schematichq/schematic-mcp

    Replace your-api-key-here with your actual Schematic API key.

Option 2: Manual Configuration

Claude Desktop / Claude Code

Add to your Claude config (~/Library/Application Support/Claude/claude_desktop_config.json on macOS):

{
  "mcpServers": {
    "schematic": {
      "command": "npx",
      "args": ["-y", "@schematichq/schematic-mcp"],
      "env": {
        "SCHEMATIC_API_KEY": "your-api-key-here"
      }
    }
  }
}

Cursor

Add to your Cursor MCP config (Settings > MCP Servers, or edit the file directly):

  • macOS: ~/.cursor/mcp.json
  • Linux: ~/.cursor/mcp.json
  • Windows: %USERPROFILE%\.cursor\mcp.json
{
  "mcpServers": {
    "schematic": {
      "command": "npx",
      "args": ["-y", "@schematichq/schematic-mcp"],
      "env": {
        "SCHEMATIC_API_KEY": "your-api-key-here"
      }
    }
  }
}

After adding the config, restart Cursor for the server to be picked up.

Configuration

The server needs a Schematic API key. It checks two sources in order:

  1. Environment variable (recommended): SCHEMATIC_API_KEY
  2. Config file (fallback): ~/.schematic-mcp/config.json
{
  "apiKey": "your-api-key-here"
}

You can find your API key in the Schematic dashboard.

Tools

Company Lookup

Tool Description
get_company Look up a company by ID, name, Stripe customer ID, or custom key. Returns details, plan, trial status, and links.
get_company_plan Get the plan a company is currently on.
get_company_trial_info Check if a company is on a trial and when it ends.
count_companies_on_plan Count how many companies are on a specific plan.
link_stripe_to_schematic Find the Schematic company for a Stripe customer ID, or vice versa.

Company Overrides

Tool Description
list_company_overrides List overrides by company or by feature.
set_company_override Set or update an override for a company on a specific feature. Supports boolean (on/off), numeric, and unlimited values.
remove_company_override Remove an override so the company falls back to plan entitlements.

Plan Management

Tool Description
list_plans List all plans.
create_plan Create a new plan.
add_entitlements_to_plan Add feature entitlements to a plan. Auto-detects feature type and sets appropriate value types.

Feature Management

Tool Description
list_features List all features.
create_feature Create a new feature flag. Supports boolean (on/off), event-based (metered), and trait-based types. Automatically creates an associated flag.

Example Prompts

Once configured, try asking your AI assistant:

  • "What plan is Acme Corp on?"
  • "List all my plans and their features"
  • "Create a boolean feature called 'Advanced Analytics'"
  • "Set an override for Acme Corp to have unlimited API calls"
  • "How many companies are on the Pro plan?"
  • "Find the Schematic company linked to Stripe customer cus_abc123"

Development

# Install dependencies
yarn install

# Build
yarn build

# Run in development mode (auto-recompile on changes)
yarn dev

# Run tests
yarn test

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors