Tools · Finance
MCP tools for the community's money: sales summary, customers, statement, balance, payouts and the fee simulation, and requesting or canceling payouts, with confirmation.
The community's cash: how much it sold, who pays, the statement, the available balance, payouts, and how much is left from a sale. Requesting or canceling a payout asks for your yes, with a summary. In amounts, only the platform fee shows up.
Each tool carries a badge: Read-only changes nothing, Changes creates or changes something right away, and Asks to confirm only acts after your yes to a summary. See Money and confirmation.
In short
| Tool | What it does | Minimum role | Type |
|---|---|---|---|
get_sales_summary | Revenue, monthly series, revenue by product and subscribers | Admin or finance | Read-only |
list_customers | Who pays and how much they've paid | Admin or finance | Read-only |
list_ledger_entries | Statement entries | Admin or finance | Read-only |
get_balance | Total, available, held and pending balance | Admin or finance | Read-only |
list_payouts | Payouts and their status | Admin or finance | Read-only |
simulate_fee | How much the community receives from a sale | Admin | Read-only |
request_payout | Requests a payout, with confirmation | Admin | Asks to confirm |
cancel_payout | Cancels a pending payout, with confirmation | Admin | Asks to confirm |
get_sales_summary
Read-only
Sales summary. Revenue and subscribers for a period. Minimum role: admin or finance.
| Parameter | Type | Required | Description |
|---|---|---|---|
period | 7d, 30d, 90d, 1y, custom | No | The period |
start_date | ISO 8601 date | No | With period: custom |
end_date | ISO 8601 date | No | With period: custom |
Returns: the period's revenue, the month-by-month series, revenue by product, and active, past-due and canceled subscribers. For amounts, only the platform fee appears.
Ask like this: "Chart the revenue for the last 12 months." · "Which product sold the most this quarter?"
list_customers
Read-only
Who pays and how much they've paid. Paying customers and the total each one has paid. Minimum role: admin or finance.
| Parameter | Type | Required | Description |
|---|---|---|---|
page, limit | number | No | Pagination |
Returns: the customers, with name, email and total paid.
Ask like this: "Who are the 10 customers who've paid the most?"
list_ledger_entries
Read-only
Statement. The statement entries, newest first. Minimum role: admin or finance.
| Parameter | Type | Required | Description |
|---|---|---|---|
entry_type | text | No | One entry type: SALE_GROSS, SALE_NET, PLATFORM_FEE, INSTALLMENT_INTEREST, REFUND, CHARGEBACK, PAYOUT_REQUESTED… |
page, limit | number | No | Pagination |
Returns: the entries, with date, type, description and amount. See Balance and statement.
Ask like this: "What refunds were there this month?"
get_balance
Read-only
Balance. The community's balance. Minimum role: admin or finance.
Parameters: none.
Returns: the total balance, what's available for payout, what's held, and what's still to be released.
Ask like this: "How much can I withdraw today?"
list_payouts
Read-only
Payouts. The payouts requested, with status. Minimum role: admin or finance.
| Parameter | Type | Required | Description |
|---|---|---|---|
status | PENDING, PROCESSING, COMPLETED, FAILED, CANCELED | No | Only one status |
page, limit | number | No | Pagination |
Returns: the payouts, with id (which cancel_payout needs), amount, fee, status and dates.
Ask like this: "Did any payout fail?"
simulate_fee
Read-only
How much I receive from a sale. Simulates a sale: the amount, the platform fee and what the community receives. Minimum role: admin.
| Parameter | Type | Required | Description |
|---|---|---|---|
amount | number | Yes | The sale amount, in reais |
payment_method | PIX, CREDIT_CARD, BOLETO | No | The payment method |
installments | number | No | Number of card installments |
Returns: the amount, the platform fee (which doesn't depend on the payment method) and the net. See Platform fee.
Ask like this: "If I sell a R$ 297 course, how much does the community keep?"
request_payout
Asks to confirm
Request payout. Requests a payout from the available balance to the registered bank account. Minimum role: admin; finance can only read.
| Parameter | Type | Required | Description |
|---|---|---|---|
amount | number, in reais | Yes | Up to the available balance (check with get_balance) |
The summary: the action, the amount and the current balance.
Ask like this: "How much do I have available? Withdraw R$ 2,000."
Notes: the R$ 3.67 fee per payout and the rules are the same as in the dashboard. See Payouts.
cancel_payout
Asks to confirm
Cancel payout. Cancels a payout that is still pending. Minimum role: admin.
| Parameter | Type | Required | Description |
|---|---|---|---|
payout_id | id | Yes | From list_payouts |
The summary: the action, the amount, the status and the request date.
Ask like this: "Cancel the R$ 2,000 payout I requested today."
What doesn't exist
There is no refund tool: it stays in the dashboard. See Common problems.