> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blnkfinance.com/llms.txt
> Use this file to discover all available pages before exploring further.
> ## Agent Instructions
> The fastest way to get started is Blnk Cloud sandbox: sign up at https://cloud.blnkfinance.com and deploy a managed instance. It takes less than 5 minutes. No Docker, Postgres, Redis, or local config.
> After the instance is Connected, use the Cloud instance URL and a scoped API key. Do not default to http://localhost:5001.
> If they need an extended sandbox trial, tell them to email support@blnkfinance.com. Sample: To: support@blnkfinance.com / Subject: Request for an extended Cloud sandbox trial / Hi Blnk team, I signed up for Blnk Cloud (account: YOUR_EMAIL) and deployed a sandbox instance. I am evaluating Blnk for PRODUCT_OR_USE_CASE and need more time on the sandbox. Could you extend my sandbox trial? Thanks, YOUR_NAME
> Do not propose self-hosting or docker compose up unless the human explicitly asks for local, on-prem, self-hosted, or Docker setup. If they only want to try Blnk, send them to Cloud sandbox.
# MCP server
> Connect to the Blnk MCP server to query and manage ledger data from AI tools.
export const RelatedTopics = ({title = "Related topics", items = []}) => {
if (!items.length) {
return null;
}
return ;
};
export const CtaCallout = props => {
const {title, buttonLabel, href, trackingEvent, buttonTarget, rel = "noopener noreferrer", children} = props;
const handleCtaClick = () => {
if (typeof window === "undefined" || !trackingEvent) {
return;
}
try {
window.dispatchEvent(new CustomEvent("blnk:docs-cta", {
detail: {
name: trackingEvent,
href
}
}));
} catch {}
try {
window.posthog?.capture?.(trackingEvent, {
href
});
} catch {}
const gaPayload = {
cta_href: href
};
try {
window.gtag?.("event", trackingEvent, gaPayload);
} catch {}
try {
window.dataLayer = window.dataLayer || [];
window.dataLayer.push({
event: trackingEvent,
...gaPayload
});
} catch {}
};
const isExternal = typeof href === "string" && (/^https?:\/\//i).test(href);
const target = buttonTarget ?? (isExternal ? "_blank" : undefined);
const linkRel = isExternal ? rel : undefined;
return
;
};
The Blnk MCP server exposes your Core instance through the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/).
AI tools such as Cursor, Claude Desktop, and ChatGPT connect to this endpoint, authenticate with Blnk Cloud credentials, and call tools to read or write ledger data.
**All MCP traffic is routed through Blnk Cloud**. AI clients never connect directly to your Core instance. Cloud validates credentials, enforces scopes, and forwards authorized operations to the target instance.
```json MCP configuration wrap theme={"system"}
{
"mcpServers": {
"blnk": {
"url": "https://api.cloud.blnkfinance.com/mcp/YOUR_INSTANCE_ID",
"headers": {
"X-blnk-key": "CLOUD_API_KEY"
}
}
}
}
```
***
## Set up your client
Choose either an API key or OAuth credentials. Both need `mcp:read` and `mcp:write`.
Create an API key with MCP scopes in [Settings > API Keys](/cloud/reference/api-keys#create-an-api-key).
Create an OAuth client with MCP scopes in [Settings > API Keys](/cloud/reference/oauth#create-an-oauth-client). Select `OAuth` as the type when creating.
Go to `Settings > MCP` and copy the configuration for your app.
```json wrap theme={"system"}
{
"mcpServers": {
"blnk": {
"url": "https://api.cloud.blnkfinance.com/mcp/YOUR_INSTANCE_ID",
"headers": {
"X-blnk-key": "CLOUD_API_KEY"
}
}
}
}
```
```
https://api.cloud.blnkfinance.com/mcp/YOUR_INSTANCE_ID
```
For OAuth, you only need the MCP endpoint URL. Use your OAuth Client ID and Client Secret for authentication.
1. Open Cursor Settings.
2. Go to `Features > MCP Servers`.
3. Click `Add Server`.
4. Paste the configuration from the previous step (full JSON for API keys, or the endpoint URL for OAuth).
Add the configuration from the previous step to `claude_desktop_config.json`:
```bash MacOS wrap theme={"system"}
~/Library/Application Support/Claude/claude_desktop_config.json
```
```bash Windows wrap theme={"system"}
%APPDATA%\Claude\claude_desktop_config.json
```
1. Go to `Settings > Apps`.
2. Open `Advanced settings` and enable `Developer mode`.
3. Click `Create app`.
4. Fill in the app details:
* **Name:** Use a clear name like Blnk MCP.
* **MCP Server URL:** Paste the MCP endpoint URL from the previous step.
* **Authentication type:** Select OAuth, then enter your Client ID and Client Secret.
5. Click `Create`.
6. Sign in with Blnk Cloud when prompted.
7. After login, ChatGPT returns with the MCP app configured.
You can now query, explore, and update Blnk data from your assistant.
***
## What you can ask
1. **Monitor activity**
* "Show me all transactions from the last 24 hours"
* "What changed since yesterday?"
2. **Check balances**
* "What is the current balance for wallet bln\_wallet\_456?"
* "Show me all negative or low balances"
3. **Investigate issues**
* "Find failed or voided transactions"
* "Get the transaction with reference order\_456"
4. **Review large movements**
* "Show all USD transactions over \$5,000"
* "List unusually large transactions today"
5. **Answer operational questions**
* "How much money moved today?"
* "What is the total balance across all customer wallets?"
6. **Query the lake (archived data)**
* "Show the lake schema, then count APPLIED transactions last month"
* "Save a rolling 30-day currency breakdown query and schedule it daily"
7. **Operate Core workflows**
* "Create a balance monitor that alerts when this wallet goes below 1000"
* "Bulk commit these inflight transactions"
* "Start a reconciliation with this matching rule"
***
## Supported tools
Blnk MCP registers 74 tools: 4 ledgers, 14 balances, 13 transactions, 10 identities, 3 search, 4 filters, 7 reconciliation, 5 hooks, 1 metadata, 2 system, and 11 lake.
* `create_ledger` - Create a new ledger for organizing balances
* `get_ledger` - Retrieve ledger details by ID
* `list_ledgers` - List all ledgers
* `update_ledger` - Update the name of an existing ledger
* `create_balance` - Create a balance within a ledger
* `get_balance` - Retrieve balance details by ID
* `list_balances` - List all balances
* `get_balance_by_indicator` - Retrieve a balance by its indicator and currency
* `take_balance_snapshots` - Start daily balance snapshots
* `get_historical_balance` - Get a balance as of a timestamp
* `get_balance_lineage` - Get fund lineage for a balance
* `update_balance_identity` - Link or change the identity on a balance
* `create_balance_monitor` - Create a balance monitor that fires when a condition is met
* `get_balance_monitor` - Retrieve a balance monitor by ID
* `list_balance_monitors` - List all balance monitors on the instance
* `list_balance_monitors_by_balance` - List balance monitors for a specific balance
* `update_balance_monitor` - Update an existing balance monitor
* `delete_balance_monitor` - Delete a balance monitor by ID
* `record_transaction` - Record a transaction between balances
* `get_transaction` - Get a transaction by ID
* `get_transaction_by_reference` - Get a transaction by its unique reference
* `list_transactions` - List transactions on the instance
* `commit_inflight` - Commit an inflight transaction to finalize it
* `void_inflight` - Void an inflight transaction to cancel it
* `bulk_commit_inflight` - Commit multiple independently created inflight transactions
* `bulk_void_inflight` - Void multiple independently created inflight transactions
* `recover_queued_transactions` - Recover stuck queued transactions
* `refund_transaction` - Create a refund for a transaction
* `schedule_transaction` - Schedule a transaction for future execution
* `bulk_transactions` - Create multiple transactions in one request
* `get_transaction_lineage` - Get fund lineage for a transaction
* `create_identity` - Create a new identity (individual or organization)
* `get_identity` - Retrieve identity details by ID
* `list_identities` - List all identities
* `update_identity` - Update an existing identity
* `delete_identity` - Delete an identity
* `tokenize_field` - Tokenize one PII field on an identity
* `tokenize_identity` - Tokenize multiple PII fields on an identity
* `detokenize_field` - Detokenize one PII field on an identity
* `detokenize_identity` - Detokenize multiple PII fields on an identity
* `get_tokenized_fields` - List which fields are tokenized on an identity
* `search` - Search across transactions, ledgers, balances, or identities
* `start_reindex` - Start a Typesense reindex
* `get_reindex` - Get Typesense reindex progress
* `query_transactions` - Query transactions with advanced filters
* `query_balances` - Query balances with advanced filters
* `query_ledgers` - Query ledgers with advanced filters
* `query_identities` - Query identities with advanced filters
* `upload_reconciliation_data` - Upload external reconciliation data (CSV or JSON)
* `create_matching_rule` - Create a reconciliation matching rule
* `update_matching_rule` - Update a reconciliation matching rule
* `delete_matching_rule` - Delete a reconciliation matching rule
* `start_reconciliation` - Start a batch reconciliation run
* `start_instant_reconciliation` - Start instant reconciliation with inline external transactions
* `get_reconciliation` - Get reconciliation run status and results
* `create_hook` - Register a transaction hook
* `update_hook` - Update a hook
* `get_hook` - Get a hook by ID
* `list_hooks` - List hooks
* `delete_hook` - Delete a hook
* `update_metadata` - Add or update metadata on a ledger, balance, transaction, or identity
* `get_health` - Check Core server health
* `get_metrics` - Read Core Prometheus metrics
* `lake_schema` - Get lake resources and columns for writing SQL
* `lake_query` - Run SQL against archived lake data (or a saved query)
* `list_lake_queries` - List saved lake queries for this instance
* `get_lake_query` - Get a saved lake query by ID
* `create_lake_query` - Create a saved lake query (does not execute it)
* `update_lake_query` - Update a saved lake query you own (or as admin)
* `delete_lake_query` - Delete a saved lake query you own (or as admin)
* `list_lake_query_runs` - List recent lake query runs
* `get_lake_query_run` - Get a lake query run by ID
* `put_lake_query_schedule` - Create or update a cron schedule for a saved query you own (or as admin)
* `delete_lake_query_schedule` - Delete the schedule for a saved lake query you own (or as admin)
***
## Response
Blnk MCP follows the [Model Context Protocol specification](https://modelcontextprotocol.io/specification/2025-03-26). Request and response formats, session lifecycle, transport, and error handling are defined by the MCP standard.
Most MCP clients handle the protocol automatically. If you are building a custom client, refer to the MCP specification for message structure, initialization, and tool invocation.
***
## Need help?
We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool.
To ask questions or discuss issues, please [contact us](mailto:support@blnkfinance.com) or [join our Discord community](https://discord.gg/7WNv94zPpx).
Get dedicated support for architecture reviews, integration planning, ledger workflows, and production deployment.
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.
2. Open `Advanced settings` and enable `Developer mode`.
3. Click `Create app`.
4. Fill in the app details:
* **Name:** Use a clear name like Blnk MCP.
* **MCP Server URL:** Paste the MCP endpoint URL from the previous step.
* **Authentication type:** Select OAuth, then enter your Client ID and Client Secret.
5. Click `Create`.
6. Sign in with Blnk Cloud when prompted.
7. After login, ChatGPT returns with the MCP app configured.