mcpField
M
mcp-vindi

mcp-vindi

Local
github.com/codesparFinance275Updated 4w ago
Repository

About mcp-vindi

mcp-vindi is an MCP server for the Vindi billing platform, exposing tools for recurring billing, subscriptions, bills and payment profiles. It suits teams that want AI assistants or agents to manage recurring charges through Vindi.

Key features

  1. 01Create, retrieve, cancel and reactivate subscriptions
  2. 02Create, retrieve, charge and cancel bills
  3. 03Manage customers and product catalog items
  4. 04Full or partial refunds and payment profile management

Use cases

  1. 01Check subscription status and cancel or reactivate subscriptions through an AI assistant
  2. 02Create bills and retry charging pending ones
  3. 03Save tokenized payment methods for customers and issue refunds

MCP support

The project runs as an MCP server that exposes 20 Vindi tools to MCP clients, letting them call the Vindi API for billing operations.

Configuration

Local server config is the same for every client. Copy it into your client’s MCP config file.

mcp.json · Universal config
{
  "mcpServers": {
    "codespar-mcp-vindi": {
      "command": "npx",
      "args": [
        "-y",
        "@codespar/mcp-vindi"
      ],
      "env": {
        "VINDI_API_KEY": "<VINDI_API_KEY>"
      }
    }
  }
}
Run commandnpx -y @codespar/mcp-vindi
Environment variables to set
VINDI_API_KEYSecretAPI key for vindi

Local servers need a runtime on your machine (e.g. Node.js 18+). Config file locations differ by client; see your client’s docs.

Packages
npm@codespar/mcp-vindi0.2.2

Tools

20

Saved tool list · updated 2w ago

ParameterTypeRequiredDescription
plan_idnumberYesPlan ID
start_atstringNoStart date (YYYY-MM-DD)
customer_idnumberYesCustomer ID
payment_method_codestringYesPayment method (credit_card, bank_slip, pix)

Details

From the project README

@codespar/mcp-vindi

MCP server for Vindi — recurring billing, subscriptions, and payment plans

npm License: MIT

Quick Start

Claude Desktop

Add to ~/.config/claude/claude_desktop_config.json:

{
  "mcpServers": {
    "vindi": {
      "command": "npx",
      "args": ["-y", "@codespar/mcp-vindi"],
      "env": {
        "VINDI_API_KEY": "your-key"
      }
    }
  }
}
Claude Code
claude mcp add vindi -- npx @codespar/mcp-vindi
Cursor / VS Code

Add to .cursor/mcp.json or .vscode/mcp.json:

{
  "servers": {
    "vindi": {
      "command": "npx",
      "args": ["-y", "@codespar/mcp-vindi"],
      "env": {
        "VINDI_API_KEY": "your-key"
      }
    }
  }
}

Tools (20)

ToolPurpose
create_subscriptionCreate a recurring subscription in Vindi
get_subscriptionGet subscription details by ID
list_subscriptionsList subscriptions with optional filters
create_billCreate a bill (charge) in Vindi
get_billGet bill details by ID
list_billsList bills with optional filters
create_customerCreate a customer in Vindi
get_customerGet customer details by ID
create_planCreate a billing plan in Vindi
list_plansList available billing plans
update_customerUpdate a customer's details
create_productCreate a product (catalog item that can be attached to plans or bills)
list_productsList products in the catalog
cancel_subscriptionCancel a subscription immediately
reactivate_subscriptionReactivate a canceled subscription
cancel_billCancel a pending bill
charge_billRetry charging a pending bill (runs the billing workflow)
refund_chargeRefund a charge (full or partial).
create_payment_profileCreate a payment profile (tokenized card / saved payment method) for a customer
list_payment_profilesList payment profiles, optionally filtered by customer

Authentication

Vindi uses Basic Auth with the API key as username and empty password.

Sandbox / Testing

Vindi provides a sandbox via the dashboard. Use a sandbox API key for testing.

Get your credentials
  1. Go to Vindi
  2. Create an account
  3. Navigate to settings and generate your API key
  4. Set the VINDI_API_KEY environment variable

Environment Variables

VariableRequiredDescription
VINDI_API_KEYYesAPI key from Vindi dashboard

Roadmap

v0.2 (planned)
  • cancel_subscription — Cancel an active subscription
  • update_subscription — Update subscription details
  • list_payment_profiles — List payment profiles for a customer
  • create_discount — Create a discount for a subscription
  • get_charges — Get charge details with filters
v0.3 (planned)
  • batch_bills — Create multiple bills in a single request
  • financial_reports — Generate financial summary reports

Want to contribute? Open a PR or request a tool.

Links

Enterprise

Need governance, budget limits, and audit trails for agent payments? CodeSpar Enterprise adds policy engine, payment routing, and compliance templates on top of these MCP servers.

License

MIT

Comments

Markdown supported

New to MCP?

From what the protocol is to installing your first server, these answers cover most first questions.

An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.