
Official flexprice MCP Server
概览
A Model Context Protocol (MCP) server that exposes the flexprice API as tools for AI assistants (e.g. Claude, Cursor, VS Code, Windsurf). Use it to manage customers, plans, prices, subscriptions, invoices, payments, events, and more from your IDE or CLI. - v20 or higher - or - from your flexprice account You can run the server in two ways: (one command) or (clone and run). Pick one, then add it to your MCP client. Install: npm i @flexprice/mcp-server. Or run with one command (no clone or build): Replace YOUR_API_KEY with your flexprice API key. Next: Add to your MCP client. Use this if you want to change code or run without npm: 1. Clone the repository and go to the MCP server directory (e.g. api/mcp or the repo that contains it). 2. Install dependencies: npm install 3. Create a .env file (from .env.example if present) with: - BASE_URL=https://us.api.flexprice.io/v1 (must include /v1; no trailing space or trailing slash) - API_KEY_APIKEYAUTH=your_api_key_here 4.
README
以下为原文 README 节选,完整内容请查看原文。
flexprice MCP Server
A Model Context Protocol (MCP) server that exposes the flexprice API as tools for AI assistants (e.g. Claude, Cursor, VS Code, Windsurf). Use it to manage customers, plans, prices, subscriptions, invoices, payments, events, and more from your IDE or CLI.
Table of contents
- Prerequisites
- How to use the flexprice MCP server
- Add to your MCP client
- Tools
- Progressive discovery (dynamic mode)
- Scopes
- Troubleshooting
- Generating the MCP server
Prerequisites
- Node.js v20 or higher
- npm or yarn
- flexprice API key from your flexprice account
How to use the flexprice MCP server
You can run the server in two ways: npm package (one command) or local repo (clone and run). Pick one, then add it to your MCP client.
Option 1: npm package
Install: npm i @flexprice/mcp-server. Or run with one command (no clone or build):
npx @flexprice/mcp-server start --server-url https://us.api.flexprice.io/v1 --api-key-auth YOUR_API_KEY
Replace YOUR_API_KEY with your flexprice API key. Next: Add to your MCP client.
Option 2: Local repo
Use this if you want to change code or run without npm:
- Clone the repository and go to the MCP server directory (e.g.
api/mcpor the repo that contains it). - Install dependencies:
npm install - Create a
.envfile (from.env.exampleif present) with:BASE_URL=https://us.api.flexprice.io/v1(must include/v1; no trailing space or trailing slash)API_KEY_APIKEYAUTH=your_api_key_here
- Build:
npm run build - Start:
npm start
Docker (stdio): You can also build and run with stdio:
docker build -t flexprice-mcp .
docker run -i -e API_KEY_APIKEYAUTH=your_api_key_here -e BASE_URL=https://us.api.flexprice.io/v1 flexprice-mcp node bin/mcp-server.js start
Next: Add to your MCP client and use the Node from repo or Docker config below.
Add to your MCP client
Add the flexprice MCP server in your editor. Replace YOUR_API_KEY with your flexprice API key in all examples. Example config snippets are in examples/.
After connecting: In Cursor, open the MCP panel and confirm the server is connected. You can list tools and try an operation (e.g. list customers) from your assistant. In Claude, use /mcp to see connected servers and available tools.
Config file locations
| Host | Config location |
|---|---|
| Cursor | Cursor → Settings → MCP (or Cmd+Shift+P → “Cursor Settings” → MCP) |
安装
npx -y @flexprice/mcp-server start --server-url https://us.api.flexprice.io/v1 --api-key-auth YOUR_API_KEY配置
{
"mcpServers": {
"flexprice": {
"command": "npx",
"args": [
"-y",
"@flexprice/mcp-server",
"start",
"--server-url",
"https://us.api.flexprice.io/v1",
"--api-key-auth",
"YOUR_API_KEY"
]
}
}
}