--- updatedAt: 2026-04-10T19:19:49.000Z agentTools: projectIndex: https://docs.pelcro.com/v2.4/llms.txt --- # Model Context Protocol (MCP) Let your AI agents interact with the Pelcro's Core API by using our MCP server. Connect your AI assistant to Pelcro's Core API through the Model Context Protocol (MCP). Manage customers, subscriptions, invoices, addresses, and more directly from your AI tools. Authentication uses OAuth 2.0 — when you connect, you log into Pelcro, select which account to grant access to, and authorize the app. The token is scoped to a single account. > 🚧 This MCP server is under active development. Tool names, parameters, and behavior may change between releases without prior notice. MCP clients should always fetch the latest tool definitions from the server at the start of each session — do not cache or hardcode tool schemas. If you have feedback or want to see more tools, email us at . ## Installation ### Claude Code ```shell claude mcp add --transport http pelcro https://mcp.pelcro.com/ ``` Start a new session with `claude`, type `/mcp`, select the server, and click **Authenticate**. ### Cursor Add to your project's `.cursor/mcp.json`: ```json { "mcpServers": { "pelcro": { "url": "https://mcp.pelcro.com/" } } } ``` ### VS Code Add a `pelcro` entry to your workspace's `.vscode/mcp.json` file. See the [VS Code MCP documentation](https://code.visualstudio.com/docs/copilot/customization/mcp-servers) for more details on configuring MCP servers. ```json { "servers": { "pelcro": { "type": "http", "url": "https://mcp.pelcro.com/" } } } ``` ### Windsurf Add to `~/.windsurf/mcp.json`: ```json { "mcpServers": { "pelcro": { "url": "https://mcp.pelcro.com/" } } } ``` ### ChatGPT ChatGPT supports remote MCP servers for Pro, Plus, Business, Enterprise, and Education accounts. To connect Pelcro, create a custom connector in **Settings > Apps & Connectors** with the server URL `https://mcp.pelcro.com/` and select **OAuth** as the authentication method. See the [OpenAI developer mode guide](https://developers.openai.com/api/docs/guides/developer-mode) for detailed setup steps. ### Other MCP clients Any client that supports remote MCP servers over Streamable HTTP can connect to `https://mcp.pelcro.com/`. The server handles OAuth discovery automatically via [RFC 9728](https://datatracker.ietf.org/doc/html/rfc9728). ## Authorize your account After installing, your MCP client will open a browser window to complete authentication: 1. Log into your Pelcro account 2. Select which account to grant access to 3. Click **Authorize** 4. Return to your AI tool — the tools are now available The token grants full read and write access to the selected account's Core API endpoints. ## Manage your connection ### Multi-account access Each MCP server entry is scoped to **one account**. To access multiple accounts, add multiple entries with different names: ```shell claude mcp add --transport http pelcro-acme https://mcp.pelcro.com/ claude mcp add --transport http pelcro-other https://mcp.pelcro.com/ ``` Each entry triggers its own OAuth flow where you pick a different account on the consent screen. ### Re-authenticate If your token expires or you want to switch accounts, remove the server and re-add it: ```shell claude mcp remove pelcro claude mcp add --transport http pelcro https://mcp.pelcro.com/ ``` ### Refreshing tools MCP clients cache the list of available tools when they first connect. If new tools are added to the server, start a new session or reconnect the MCP server to pick them up. ### Environments | Environment | URL | | ----------- | --------------------------------- | | Production | `https://mcp.pelcro.com/` | | Staging | `https://mcp-staging.pelcro.com/` | ## Tools Most tools require a `site_id` parameter. If you don't know your site ID, use `get_account` first to discover your available sites. List tools support `page` and `limit` for pagination. ### Response size Tool responses are capped at 25,000 characters to protect AI context windows. If a response is truncated, use a smaller `limit` value or add filters to narrow your results. ### Error handling API errors (400, 401, 404, 500, etc.) are returned as tool results with `isError: true`, not as protocol-level failures. This allows the AI to reason about the error and retry with different parameters. | Resource | Tool | API | | ----------------------- | ----------------------------- | --------------------------------------------------------------------- | | **Addresses** | `list_addresses` | [List addresses](https://docs.pelcro.com/reference/api-core-list-addresses) | | | `get_address` | [Get address](https://docs.pelcro.com/reference/api-core-get-address) | | | `create_address` | [Create address](https://docs.pelcro.com/reference/api-core-create-address) | | | `update_address` | [Update address](https://docs.pelcro.com/reference/api-core-update-address) | | | `delete_address` | [Delete address](https://docs.pelcro.com/reference/api-core-delete-address) | | **Bills** | `list_bills` | [List bills](https://docs.pelcro.com/reference/list-bills) | | | `get_bill` | [Get bill](https://docs.pelcro.com/reference/get-bill) | | | `create_bill` | [Create bill](https://docs.pelcro.com/reference/create-bills) | | | `update_bill` | [Update bill](https://docs.pelcro.com/reference/update-bill) | | | `delete_bill` | [Delete bill](https://docs.pelcro.com/reference/api-core-delete-bill) | | | `finalize_bill` | [Finalize bill](https://docs.pelcro.com/reference/api-core-finalize-bill) | | | `mark_bill_as_paid` | [Mark bill as paid](https://docs.pelcro.com/reference/api-core-mark-bill-as-paid) | | | `export_bills` | [Export bills](https://docs.pelcro.com/reference/api-core-export-bills) | | **Charges** | `list_charges` | [List charges](https://docs.pelcro.com/reference/api-core-list-charges) | | | `get_charge` | [Get charge](https://docs.pelcro.com/reference/api-core-get-charge) | | | `create_offline_charge` | [Create offline charge](https://docs.pelcro.com/reference/api-core-create-offline-charge) | | **Coupons** | `list_coupons` | [List coupons](https://docs.pelcro.com/reference/api-core-list-coupons) | | | `get_coupon` | [Get coupon](https://docs.pelcro.com/reference/api-core-get-coupon) | | | `create_coupon` | [Create coupon](https://docs.pelcro.com/reference/api-core-create-coupon) | | | `update_coupon` | [Update coupon](https://docs.pelcro.com/reference/api-core-update-coupon) | | | `delete_coupon` | [Delete coupon](https://docs.pelcro.com/reference/api-core-delete-coupon) | | **Customers** | `list_customers` | [List customers](https://docs.pelcro.com/reference/api-core-list-customers) | | | `get_customer` | [Get customer](https://docs.pelcro.com/reference/api-core-get-customer) | | | `create_customer` | [Create customer](https://docs.pelcro.com/reference/api-core-create-customer) | | | `update_customer` | [Update customer](https://docs.pelcro.com/reference/api-core-update-customer) | | | `delete_customer` | [Delete customer](https://docs.pelcro.com/reference/api-core-delete-customer) | | | `credit_from_payment_method` | [Credit from payment method](https://docs.pelcro.com/reference/api-core-credit-from-payment-method) | | | `delete_customer_metadata` | [Delete customer metadata](https://docs.pelcro.com/reference/api-core-delete-customer-metadata) | | **E-Commerce Orders** | `list_orders` | [List orders](https://docs.pelcro.com/reference/api-core-list-ecommerce-orders) | | | `get_order` | [Get order](https://docs.pelcro.com/reference/api-core-get-ecommerce-order) | | | `create_order` | [Create order](https://docs.pelcro.com/reference/api-core-create-ecommerce-order) | | | `update_order` | [Update order](https://docs.pelcro.com/reference/api-core-update-ecommerce-order) | | **E-Commerce Products** | `list_ecommerce_products` | [List e-commerce products](https://docs.pelcro.com/reference/api-core-list-ecommerce-products) | | | `get_ecommerce_product` | [Get e-commerce product](https://docs.pelcro.com/reference/api-core-get-ecommerce-product) | | | `create_ecommerce_product` | [Create e-commerce product](https://docs.pelcro.com/reference/api-core-create-ecommerce-product) | | | `update_ecommerce_product` | [Update e-commerce product](https://docs.pelcro.com/reference/api-core-update-ecommerce-product) | | | `delete_ecommerce_product` | [Delete e-commerce product](https://docs.pelcro.com/reference/api-core-delete-ecommerce-product) | | **E-Commerce SKUs** | `list_ecommerce_skus` | [List SKUs](https://docs.pelcro.com/reference/api-core-list-ecommerce-skus) | | | `get_ecommerce_sku` | [Get SKU](https://docs.pelcro.com/reference/api-core-get-ecommerce-sku) | | | `create_ecommerce_sku` | [Create SKU](https://docs.pelcro.com/reference/api-core-create-ecommerce-sku) | | | `update_ecommerce_sku` | [Update SKU](https://docs.pelcro.com/reference/api-core-update-ecommerce-sku) | | | `delete_ecommerce_sku` | [Delete SKU](https://docs.pelcro.com/reference/api-core-delete-ecommerce-sku) | | **Exports** | `list_exports` | [List exports](https://docs.pelcro.com/reference/api-core-list-exports) | | | `request_export` | [Request export](https://docs.pelcro.com/reference/api-core-request-export) | | | `download_export` | [Download export](https://docs.pelcro.com/reference/api-core-download-export) | | **Invoices** | `list_invoices` | [List invoices](https://docs.pelcro.com/reference/api-core-list-invoices) | | | `get_invoice` | [Get invoice](https://docs.pelcro.com/reference/get-invoice) | | | `create_invoice` | [Create invoice](https://docs.pelcro.com/reference/create-invoice) | | | `update_invoice` | [Update invoice](https://docs.pelcro.com/reference/update-invoice) | | | `pay_invoice_offline` | [Pay invoice](https://docs.pelcro.com/reference/api-core-pay-invoice) | | | `void_invoice` | [Void invoice](https://docs.pelcro.com/reference/api-core-void-invoice) | | | `mark_invoice_uncollectible` | [Mark uncollectible](https://docs.pelcro.com/reference/api-core-mark-as-uncollectible-invoices) | | | `apply_balance_to_invoice` | [Apply balance](https://docs.pelcro.com/reference/api-core-apply-balance-to-invoice) | | **Memberships** | `list_memberships` | [List members](https://docs.pelcro.com/reference/api-core-list-memberships) | | | `get_membership` | [Get member](https://docs.pelcro.com/reference/api-core-get-membership) | | | `create_membership` | [Create member](https://docs.pelcro.com/reference/api-core-create-membership) | | | `invite_member` | [Invite member](https://docs.pelcro.com/reference/api-core-invite-member) | | | `update_membership` | [Update member](https://docs.pelcro.com/reference/api-core-update-membership) | | | `delete_membership` | [Delete member](https://docs.pelcro.com/reference/api-core-delete-membership) | | | `membership_ip_authorization` | [IP authorization](https://docs.pelcro.com/reference/api-core-member-ip-authorization) | | **Newsletters** | `list_newsletters` | [List newsletters](https://docs.pelcro.com/reference/api-core-list-newsletters) | | | `get_newsletter` | [Get newsletter](https://docs.pelcro.com/reference/api-core-get-newsletter) | | | `create_newsletter` | [Create newsletter](https://docs.pelcro.com/reference/api-core-create-newsletter) | | | `update_newsletter` | [Update newsletter](https://docs.pelcro.com/reference/api-core-update-newsletter) | | | `delete_newsletter` | [Delete newsletter](https://docs.pelcro.com/reference/api-core-delete-newsletter) | | **Payment Methods** | `list_payment_methods` | [List payment methods](https://docs.pelcro.com/reference/api-core-list-payment-methods) | | | `get_payment_method` | [Get payment method](https://docs.pelcro.com/reference/api-core-get-payment-method) | | | `create_payment_method` | [Create payment method](https://docs.pelcro.com/reference/api-core-create-payment-method) | | | `delete_payment_method` | [Delete payment method](https://docs.pelcro.com/reference/api-core-delete-payment-method) | | **Refunds** | `list_refunds` | [List refunds](https://docs.pelcro.com/reference/api-core-list-refunds) | | | `cancel_refunds` | [Cancel refunds](https://docs.pelcro.com/reference/cancel-refunds) | | **Plans** | `list_plans` | [List plans](https://docs.pelcro.com/reference/api-core-list-plans) | | | `get_plan` | [Get plan](https://docs.pelcro.com/reference/api-core-get-plan) | | | `create_plan` | [Create plan](https://docs.pelcro.com/reference/api-core-create-plan) | | | `update_plan` | [Update plan](https://docs.pelcro.com/reference/api-core-update-plan) | | | `delete_plan` | [Delete plan](https://docs.pelcro.com/reference/api-core-delete-plan) | | **Products** | `list_products` | [List products](https://docs.pelcro.com/reference/api-core-list-products) | | | `get_product` | [Get product](https://docs.pelcro.com/reference/api-core-get-product) | | | `create_product` | [Create product](https://docs.pelcro.com/reference/api-core-create-product) | | | `update_product` | [Update product](https://docs.pelcro.com/reference/api-core-update-product) | | | `delete_product` | [Delete product](https://docs.pelcro.com/reference/api-core-delete-product) | | **Subscriptions** | `list_subscriptions` | [List subscriptions](https://docs.pelcro.com/reference/api-core-list-subcriptions) | | | `get_subscription` | [Get subscription](https://docs.pelcro.com/reference/api-core-get-subscription) | | | `create_subscription` | [Create subscription](https://docs.pelcro.com/reference/api-core-create-subscription) | | | `update_subscription` | [Update subscription](https://docs.pelcro.com/reference/api-core-update-subscription) | | | `cancel_subscription` | [Cancel subscription](https://docs.pelcro.com/reference/api-core-cancel-subscription) | | | `renew_subscription` | [Renew subscription](https://docs.pelcro.com/reference/api-core-renew-subscription) | | | `delete_subscription_phase` | [Delete phase](https://docs.pelcro.com/reference/api-core-delete-phase) | | | `redeem_subscription` | [Redeem gift](https://docs.pelcro.com/reference/api-core-redeem-subscription) | | **Vendors** | `list_vendors` | [List vendors](https://docs.pelcro.com/reference/api-core-list-vendors) | | | `get_vendor` | [Get vendor](https://docs.pelcro.com/reference/api-core-get-vendor) | | | `create_vendor` | [Create vendor](https://docs.pelcro.com/reference/api-core-create-vendor) | | | `update_vendor` | [Update vendor](https://docs.pelcro.com/reference/api-core-update-vendor) | | | `delete_vendor` | [Delete vendor](https://docs.pelcro.com/reference/api-core-delete-vendor) | | | `export_vendors` | [Export vendors](https://docs.pelcro.com/reference/api-core-export-vendors) | | **Webhooks** | `list_webhooks` | [List webhooks](https://docs.pelcro.com/reference/api-core-list-webhooks) | | | `get_webhook` | [Get webhook](https://docs.pelcro.com/reference/api-core-get-webhook) | | | `create_webhook` | [Create webhook](https://docs.pelcro.com/reference/api-core-create-webhook) | | | `update_webhook` | [Update webhook](https://docs.pelcro.com/reference/api-core-update-webhook) | | | `delete_webhook` | [Delete webhook](https://docs.pelcro.com/reference/api-core-delete-webhook) | ## Health check ```shell curl https://mcp.pelcro.com/health ``` ```json {"status": "ok", "version": "1.2.1", "environment": "prd"} ``` # Sub pages * [MCP Examples](https://docs.pelcro.com/v2.4/docs/mcp-examples.md) # Sibling pages * [JavaScript SDK](https://docs.pelcro.com/v2.4/docs/js-sdk.md) * [Webhooks](https://docs.pelcro.com/v2.4/docs/webhooks.md) * [iOS SDK](https://docs.pelcro.com/v2.4/docs/ios-sdk.md) * [Android SDK](https://docs.pelcro.com/v2.4/docs/android-sdk.md)