Skip to main content

MCP Tools Reference

MCP tools share the REST free and developer lanes. Each tool call counts against those rate limits. REST /api exposes the same capabilities over HTTP.

Protocol tools accept optional chainId (8453, "8453", or "eip155:8453"). Omitted uses Base. Invalid values return INVALID_INPUT. See MCP chain selection.

Read tools

ToolDescription
list_chainsProtocol chains available to MCP (default is Base; mcp: true rows are selectable)
get_protocol_stateCurrent fee configuration
get_subscriptionSingle subscription by ID
get_account_subscriptionsList subscriptions for an account. Requires account and bySubscriber (true = subscribed to, false = created as provider)
get_accountEnriched account: subscribedTo + created
get_fee_balanceFee balance for a subscriber on a subscription
get_subscribersSubscribers and fee balances
get_approved_tokenToken configuration (on-chain)
list_approved_tokensAll approved tokens with minimum and paused
get_subscriptions_dueSingle-day due probe

Discovery tools

ToolDescription
search_subscriptionsFilters: provider, token, frequency, cancelled, includeDetails, first, skip
get_subscription_detailsCurrent url/description

History and profile tools

Subgraph-backed. Max 200 records per call; includes hasMore for pagination.

ToolDescription
get_subscription_historySubLog events with normalized amounts
get_account_activityMerged subscriber + provider activity
get_provider_profileLatest provider profile
get_subscription_details_historyURL/description change history

Write tools

ToolDescription
check_subscribe_readinessValidate allowance, balance, protocol rules
check_subscribe_readiness_by_idPreferred — readiness with from + id
prepare_create_subscriptionPrepare unsigned createSubscription (human amount string)
prepare_subscribePrepare subscribe (object form; includes approve when needed)
prepare_subscribe_by_idPreferred — prepare subscribe with from + id
prepare_cancel_subscriptionProvider cancel
prepare_cancel_subscription_by_idPreferred — cancel with from + id
prepare_unsubscribeSubscriber unsubscribe
prepare_unsubscribe_by_idPreferred — unsubscribe with from + id
prepare_unsubscribe_by_providerProvider-initiated unsubscribe
prepare_unsubscribe_by_provider_by_idPreferred — provider remove with from + id + subscriber
prepare_edit_detailsProvider metadata edit
check_remit_readinessMulti-day due scan before remit()
prepare_remitPrepare permissionless remit()
get_transaction_statusPoll confirmation after broadcast (txHash)

Full prepare runs on-chain simulation. Failed simulation throws. Prefer *_by_id tools when the subscription id is known.