billforward-mcp
The Billforward MCP server integrates Billforward's billing and subscription management API with LLMs, enabling read and write operations across accounts, subscriptions, invoices, payments, and product catalogs.
Search & Insights
search– Unified search across accounts, subscriptions, and invoices by email, ID, or keywordget-customer-summary– 360-degree customer dashboard combining account details, subscriptions, credit balances, and recent invoicesget-metadata-schema– Discover custom metadata fields in use across accounts, subscriptions, and invoices
Guidance & Auth
help– Overview of available tools and usage patternsget-me– Validate API credentials and view authenticated user/org info
Account Management
List, get by ID or email, create, and update customer accounts; list profiles; supports filtering by metadata and date range
Subscription Management
List, get details, create, and cancel subscriptions, with billing period date filters
Invoices & Payments
List and retrieve invoices (with line items, taxes, payment status), payments, and receipts; supports date-based filtering
Catalog & Pricing
List products and rate plans; get full rate plan details including pricing components and tiers
Security & Configuration
Configurable read-only mode (
BILLFORWARD_READ_ONLY) blocks mutation operations and returns instructional errors for LLMsConfigurable via environment variables: API tokens (sandbox/production), custom API URLs, result limits, and request timeouts
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@billforward-mcpget customer summary for john@example.com"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Billforward MCP Server
This MCP server connects LLMs to Billforward through a small always-on tool surface: lookup resolves prefixed IDs and free-text search, while search-tools, describe-tool, and call-api discover and execute operations from an in-package API catalog—covering the full API without registering hundreds of per-endpoint tools.
flowchart LR
Model --> AlwaysOn
AlwaysOn --> Lookup
AlwaysOn --> ToolSearch
AlwaysOn --> Help
ToolSearch -->|"matches"| Catalog
Catalog --> Describe
Describe --> Call
Lookup -->|"PREFIX-id"| GetById
Lookup -->|"email/texto"| SearchV3Configuration
Primary config: BILLFORWARD_ENVIRONMENTS — a JSON object of named environments (lowercase slugs you choose). Each entry needs token and type (sandbox or production); readonly defaults to true (only JSON false enables writes). Optional baseUrl overrides the default for that type.
BILLFORWARD_ENVIRONMENTS='{"dev":{"token":"your_dev_token","type":"sandbox","readonly":true},"staging":{"token":"your_staging_token","type":"sandbox","readonly":true},"prod":{"token":"your_production_token","type":"production","readonly":true}}'With one environment configured, tools select it automatically. With two or more, pass the exact name via each tool's environment parameter.
Create a local .env from the template and keep every environment read-only until writes are explicitly needed:
cp .env.example .envBILLFORWARD_ENVIRONMENTS='{"dev":{"token":"your_dev_token","type":"sandbox","readonly":true},"staging":{"token":"your_staging_token","type":"sandbox","readonly":true},"prod":{"token":"your_production_token","type":"production","readonly":true}}'
BILLFORWARD_TIMEOUT=15000MCP client setup
.mcp.json (loads .env from workspace root):
{
"mcpServers": {
"billforward": {
"command": "bash",
"args": ["-lc", "set -a; source .env; set +a; exec npx -y billforward-mcp"]
}
}
}VS Code / Cursor (.vscode/mcp.json):
{
"servers": {
"billforward": {
"type": "stdio",
"command": "npx",
"args": ["-y", "billforward-mcp"],
"envFile": "${workspaceFolder}/.env"
}
}
}Inline env (when the client does not load env files):
{
"mcpServers": {
"billforward": {
"command": "npx",
"args": ["-y", "billforward-mcp"],
"env": {
"BILLFORWARD_ENVIRONMENTS": "{\"dev\":{\"token\":\"your_dev_token\",\"type\":\"sandbox\",\"readonly\":true},\"staging\":{\"token\":\"your_staging_token\",\"type\":\"sandbox\",\"readonly\":true},\"prod\":{\"token\":\"your_production_token\",\"type\":\"production\",\"readonly\":true}}"
}
}
}
}Related MCP server: QuickFile MCP Server
How to Get Your API Token
Log in to your Billforward environment.
Go to Setup > Personal > API Keys.
Create a token and copy it.
Available Tools
Discovery (always on)
Tool | Purpose |
| Prefixed ID ( |
| Keyword search over the API catalog → operation names |
| Full schema for one catalog entry (method, path, params) |
| Execute a catalog entry by name (writes need a write-enabled environment) |
| Developer guide and configured environment summary |
| Validate credentials via |
Typical flow: lookup for IDs and text search → search-tools → describe-tool → call-api for lists and writes.
Convenience
Tool | Purpose |
| Paginated account search with metadata filters |
| Account-scoped subscriptions and invoices |
| 360° view: profile, subscriptions, recent invoices, dunning |
| Custom metadata keys in use across accounts, subscriptions, invoices |
Upgrading to 2.0
Version 2.0 replaces per-endpoint tools with discovery-first tools. Ops are unchanged (npx billforward-mcp + env tokens).
Old tool | Replacement |
|
|
|
|
|
|
dedicated |
|
Full changelog: CHANGELOG.md on GitHub
Security
Named environments default to read-only (readonly: true). Only set "readonly": false for environments that should allow writes.
When read-only is active, write catalog entries (create-account, update-subscription, etc.) are blocked with a descriptive error.
Development
pnpm run build
pnpm testMaintenance
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.
Related MCP Servers
- Flicense-qualityDmaintenanceEnables interaction with Zuora's billing and subscription management platform through their REST API. Provides access to billing operations, subscription management, and financial data through natural language queries.
- Alicense-qualityAmaintenanceEnables AI assistants to interact with QuickFile UK accounting software, providing access to invoicing, client management, purchases, banking, and financial reporting through 40+ tools covering the complete QuickFile API.4MIT
- AlicenseBqualityBmaintenanceEnables AI assistants to manage BuchhaltungsButler bookkeeping through all 48 API endpoints, with safety-categorized tools for read, write, and destructive operations.48342MIT
- Flicense-qualityDmaintenanceEnables AI agents to interact with FreshBooks accounting API for managing clients, invoices, payments, and more through natural language.
Related MCP Connectors
Gateway between LLM agents and world data through eight tools and a bundled endpoint catalog.
SaaS intelligence for AI agents. 5 unified tools cover 1,000+ services with 91-96% token savings.
Read-only bank access for your AI agent. Connects Claude, ChatGPT, Cursor, Gemini, Codex.
Appeared in Searches
Latest Blog Posts
- Who's Calling? MCP Hosts Are an Identity Blind Spot (And the Spec Knows It)By Om-Shree-0709 on .mcpAgent IdentityOAuth 2.1
- Your AI Chatbot Just Exposed Your CEO's Salary to an InternBy Om-Shree-0709 on .Agent IdentityMCP SecurityOAuth Delegation
- Why MCP Servers Need Execution Sandboxing (And Why Your Current Stack Isn't Enough)By Om-Shree-0709 on .Agentic AiPrompt InjectionWebAssembly
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/GregoriSoria/billforward-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server