Business tools.
Every tool a business owner's AI connection can use, with what it does, how safe it is, what access it needs and which plan feature it depends on.
On this page
A business owner's connection acts as that business owner and never reaches another business. This page lists every tool it can be offered. A connection sees only the tools that match its access and the features on the business's plan.
| What the tool does | Tools |
|---|---|
| Reads | 73 |
| Changes | 58, of which 7 wait for approval in some cases |
| Waits for approval | 16 |
| Waits for approval over MCP | 12 |
| Opens a tool family or runs a change you approved | 3 |
| All tools | 162, in 28 families |
How to read the tables
- Tool is the name your AI client sees. It is also the
operationIdin the OpenAPI spec. - Safety says what a call does. Reads changes nothing. Changes makes an everyday change that Reward Loyalty logs. Waits for approval only prepares the change and gives you a review link. Nothing runs until you approve it. See Approvals.
- Waits for approval over MCP applies to deletes and stored-money moves. Over the HTTP Agent API they run at once. Rows that say waits for approval for a condition wait over both.
- Access lists the scopes. A connection needs one of the listed scopes, unless the cell says All of. Scopes and permissions explains each scope. Access and security shows which access choice grants them.
- Tools marked contacts an outside service send a request from your server to another system, such as a store or your webhook endpoint.
Tools in families
A connection gets a tool list that fits its access and your plan. When the full list would be too large for an AI client, the platform keeps some families out of the list. Those tools stay available through two tools that are always in the list: describe_tool_family and run_family_tool. The AI client first asks which tools a family holds, then runs one by name. The same access checks and approvals apply. Which families are kept out depends on the connection's access and your plan. Ask the client to call describe_tool_family to see them. The list is limited to 90 tools and 150 KB.
Plan feature names the feature the business needs. A tool whose feature is off for the business is not in its tool list. None means no feature gate beyond the Agent API itself.
The tools
Insights
Dashboard, member overview and per-program analytics.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
get_loyalty_card_analytics |
Get one loyalty card's analytics | Reads | One of read, read:analytics |
Loyalty cards |
get_member_overview |
Get one member's relationship with the business | Reads | read |
None |
get_money_pass_analytics |
Get stored-money pass analytics | Reads | All of read:money |
Prepaid passes |
get_partner_dashboard |
Get the business dashboard | Reads | One of read, read:analytics |
None |
get_pass_analytics |
Get one visit pass's analytics | Reads | One of read, read:analytics |
Prepaid passes |
get_stamp_card_analytics |
Get one stamp card's analytics | Reads | One of read, read:analytics |
Stamp cards |
get_voucher_analytics |
Get one voucher's analytics | Reads | One of read, read:analytics |
Vouchers |
Account
Plan and usage, activity analytics and what the QR studio can print.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
get_activity_analytics |
Get the business's activity log analytics | Reads | One of read, read:analytics |
Activity |
get_plan_and_usage |
Get the plan, its limits and usage | Reads | read |
None |
get_qr_targets |
Get what the QR studio can print | Reads | read |
None |
Members
Members who interacted with your business.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
get_member |
Get a specific member | Reads | read |
None |
get_member_balance |
Get a member's balance on a specific card | Reads | read |
None |
list_members |
List members who interacted with this business | Reads | read |
None |
Search
One search across members, programs, staff and tickets.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
search |
Search members, programs, staff and support tickets | Reads | read |
None |
Records
The lists you see in your dashboard, with the same filters and sorting.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
describe_records |
Describe the business's console lists | Reads | read |
None |
get_record |
Get one row of a business console list | Reads | read |
None |
list_records |
List rows of a business console list | Reads | read |
None |
Clubs
Locations and club settings.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
create_club |
Create a new club | Changes | write:clubs |
None |
delete_club |
Delete a club | Waits for approval over MCP | write:clubs |
None |
get_club |
Get a specific club | Reads | One of read, write:clubs |
None |
list_clubs |
List all clubs for this partner | Reads | One of read, write:clubs |
None |
update_club |
Update an existing club | Changes; waits for approval for reactivating a voucher or club that an automatic email depends on | write:clubs |
None |
Loyalty cards
Points cards.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
create_loyalty_card |
Create a new loyalty card | Changes | write:cards |
Loyalty cards |
delete_loyalty_card |
Delete a loyalty card | Waits for approval over MCP | write:cards |
Loyalty cards |
get_loyalty_card |
Get a specific loyalty card | Reads | One of read, write:cards |
Loyalty cards |
list_loyalty_cards |
List all loyalty cards for this partner | Reads | One of read, write:cards |
Loyalty cards |
update_loyalty_card |
Update an existing loyalty card | Changes | write:cards |
Loyalty cards |
Rewards
Rewards members redeem with points.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
create_reward |
Create a new reward | Changes | write:rewards |
Loyalty cards |
delete_reward |
Delete a reward | Waits for approval over MCP | write:rewards |
Loyalty cards |
get_reward |
Get a specific reward | Reads | One of read, write:rewards |
Loyalty cards |
list_rewards |
List all rewards for this partner | Reads | One of read, write:rewards |
Loyalty cards |
update_reward |
Update an existing reward | Changes | write:rewards |
Loyalty cards |
Stamp cards
Stamp cards and stamping.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
add_stamps |
Add stamps to a member's stamp card | Changes | One of counter:stamps, write:stamps |
Stamp cards |
create_stamp_card |
Create a new stamp card | Changes | write:stamps |
Stamp cards |
delete_last_stamp |
Delete a member's last stamps | Waits for approval | write:stamps |
Stamp cards |
delete_stamp_card |
Delete a stamp card | Waits for approval over MCP | write:stamps |
Stamp cards |
get_stamp_card |
Get a specific stamp card | Reads | One of read, write:stamps |
Stamp cards |
list_stamp_cards |
List all stamp cards for this partner | Reads | One of read, write:stamps |
Stamp cards |
redeem_stamp_reward |
Redeem a pending stamp reward | Changes | One of counter:stamps, write:stamps |
Stamp cards |
undo_last_stamp |
Undo the last stamps for a member | Changes | One of counter:stamps, write:stamps |
Stamp cards |
update_stamp_card |
Update an existing stamp card | Changes | write:stamps |
Stamp cards |
Vouchers
Vouchers and redeeming them.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
create_voucher |
Create a new voucher | Changes; waits for approval for a voucher that would be emailed to tier members at once | write:vouchers |
Vouchers |
delete_last_voucher_redemption |
Delete a member's last voucher redemption | Waits for approval | write:vouchers |
Vouchers |
delete_voucher |
Delete a voucher | Waits for approval over MCP | write:vouchers |
Vouchers |
get_voucher |
Get a specific voucher | Reads | One of read, write:vouchers |
Vouchers |
list_vouchers |
List all vouchers for this partner | Reads | One of read, write:vouchers |
Vouchers |
redeem_voucher |
Redeem a voucher for a member | Changes | One of counter:vouchers, write:vouchers |
Vouchers |
update_voucher |
Update an existing voucher | Changes; waits for approval for reactivating a voucher that an automatic email depends on, or a voucher that would be emailed to tier members at once | write:vouchers |
Vouchers |
validate_voucher |
Validate a voucher code without redeeming | Reads | One of read, counter:vouchers, write:vouchers |
Vouchers |
void_voucher_redemption |
Void a voucher redemption | Changes | One of counter:vouchers, write:vouchers |
Vouchers |
Voucher batches
Batches of voucher codes.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
delete_unused_vouchers |
Delete the unused codes of a voucher batch | Waits for approval | write:vouchers |
Voucher batches |
delete_voucher_batch |
Delete a voucher batch | Waits for approval | write:vouchers |
Voucher batches |
extend_voucher_batch |
Change the end date of a voucher batch | Changes | write:vouchers |
Voucher batches |
generate_voucher_batch |
Generate a batch of voucher codes | Changes | write:vouchers |
Voucher batches |
get_voucher_batch |
Get one voucher batch with its codes | Reads | read |
Voucher batches |
import_voucher_codes |
Import voucher codes | Changes | write:vouchers |
Voucher batches |
list_voucher_batches |
List voucher batches | Reads | read |
Voucher batches |
set_voucher_batch_active |
Pause or resume a voucher batch | Changes | write:vouchers |
Voucher batches |
Prepaid passes
Visit passes and stored-money passes.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
create_prepaid_pass |
Create a new prepaid pass template | Changes | write:passes |
Prepaid passes |
delete_prepaid_pass |
Delete a prepaid pass template | Waits for approval over MCP | write:passes |
Prepaid passes |
get_member_pass |
Get a sold pass with its ledger history | Reads | One of read, write:passes |
Prepaid passes |
get_money_overview |
List the business's stored-money accounts or sales | Reads | All of read:money |
None |
get_money_pass_setup |
Get the stored-money setup | Reads | All of read:money |
None |
get_money_record |
Get one stored-money account or sale | Reads | All of read:money |
None |
get_prepaid_pass |
Get a specific prepaid pass template | Reads | One of read, write:passes |
Prepaid passes |
list_member_passes |
List a member's sold passes in this partner's clubs | Reads | One of read, write:passes |
Prepaid passes |
list_prepaid_passes |
List all prepaid pass templates for this partner | Reads | One of read, write:passes |
Prepaid passes |
reverse_pass_money_spend |
Reverse one complete monetary spend | Waits for approval over MCP | All of write:passes, write:pass-money |
None |
scan_member_pass |
Deduct one or more visits from a sold pass | Changes | One of counter:passes, write:passes |
Prepaid passes |
sell_prepaid_pass |
Sell (issue) a pass to a member | Changes; selling stored-money passes waits for approval over MCP | write:passes |
Prepaid passes |
spend_pass_money |
Spend a monetary pass balance | Waits for approval over MCP | All of write:passes, write:pass-money |
None |
undo_member_pass_use |
Undo the most recent visit on a sold pass | Changes | One of counter:passes, write:passes |
Prepaid passes |
update_prepaid_pass |
Update a prepaid pass template | Changes | write:passes |
Prepaid passes |
New monetary sales need an enabled, complete setup and the Prepaid passes plan feature. Existing-balance reads, spending and spend reversals remain available when sales stop. Money analytics still needs Prepaid passes. The setup read remains available after a downgrade if the business has a saved setup. Scope checks and account restrictions still apply. See Limits, errors and retries.
Tiers
Member tiers.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
create_tier |
Create a new tier | Changes | write:tiers |
None |
delete_tier |
Delete a tier | Waits for approval over MCP | write:tiers |
None |
get_tier |
Get a specific tier | Reads | One of read, write:tiers |
None |
list_tier_corrections |
List members a counting error moved up a tier | Reads | One of read, write:tiers |
None |
list_tiers |
List all tiers for this partner | Reads | One of read, write:tiers |
None |
resolve_tier_corrections |
Settle members a counting error moved up a tier | Waits for approval | write:tiers |
None |
update_tier |
Update an existing tier | Changes; waits for approval for changes to a tier that move members and email them | write:tiers |
None |
Transactions
Purchases, redemptions, deductions, claim codes and corrections.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
create_points_claim_code |
Create a points claim code for a customer | Changes | One of counter:earn, write:transactions |
None |
deduct_points |
Deduct points from a member balance | Changes | One of counter:redeem, write:transactions |
None |
delete_last_transaction |
Delete a member's last points transaction | Waits for approval | write:transactions |
None |
delete_points_claim_code |
Delete an unclaimed points claim code | Waits for approval over MCP | One of counter:earn, write:transactions |
None |
get_points_claim_code |
Check the state of a points claim code | Reads | One of read, counter:earn, write:transactions |
None |
list_transactions |
List transactions for this partner | Reads | One of read, write:transactions |
None |
record_purchase |
Record a purchase and award loyalty points | Changes | One of counter:earn, write:transactions |
None |
redeem_reward |
Redeem a reward and deduct loyalty points | Changes | One of counter:redeem, write:rewards |
None |
undo_last_points_credit |
Undo the last points credit for a member | Changes | One of counter:earn, write:transactions |
None |
Segments
Saved member segments.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
count_segment |
Count the members a segment reaches | Reads | read |
Member segments |
create_segment |
Create a member segment | Changes | write:segments |
Member segments |
delete_segment |
Delete a member segment | Waits for approval | write:segments |
Member segments |
get_segment |
Get one saved member segment | Reads | read |
Member segments |
list_segments |
List saved member segments | Reads | read |
Member segments |
update_segment |
Change a member segment | Changes | write:segments |
Member segments |
Campaigns
Email campaign drafts and sending.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
create_email_campaign_draft |
Draft an email campaign | Changes | write:campaigns |
Email campaigns |
delete_email_campaign |
Delete an email campaign | Waits for approval | write:campaigns |
Email campaigns |
get_email_campaign |
Get one email campaign | Reads | read |
Email campaigns |
list_email_campaigns |
List email campaigns | Reads | read |
Email campaigns |
preview_campaign_audience |
Preview who an email campaign would reach | Reads | read |
Email campaigns |
send_email_campaign |
Send an email campaign draft | Waits for approval | write:campaigns |
Email campaigns |
send_next_campaign_batch |
Send the next batch of an email campaign | Waits for approval | write:campaigns |
Email campaigns |
update_email_campaign_draft |
Change an email campaign draft | Changes | write:campaigns |
Email campaigns |
Automations
Automatic member messages and rewards for each club.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
get_lifecycle_automations |
Get the member messages and automated rewards of each club | Reads | read |
None |
update_lifecycle_automations |
Change a club's member messages and automated rewards | Changes; waits for approval for switching on an automatic email | write:automations |
None |
Achievements
The achievements program, grants and insights.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
get_achievement_grant |
Get one achievement reward | Reads | read |
None |
get_achievement_insights |
Get the achievements program insights | Reads | read |
Achievements |
get_achievement_program |
Get the achievements program, rules, and insights | Reads | read |
Achievements |
get_member_achievements |
Get a member's achievement progress at this partner | Reads | read |
Achievements |
honor_achievement_grant |
Deliver a failed reward whose product was switched off | Changes | write:achievements |
None |
list_achievement_grants |
List achievement rewards and their delivery status | Reads | read |
None |
preview_achievement_program |
Preview the reach and cost of draft achievement rewards | Reads | One of read, write:achievements |
Achievements |
reconcile_achievements |
Import past activity into the achievements program | Changes | write:achievements |
Achievements |
release_achievement_grant |
Close a failed achievement reward for good | Waits for approval | write:achievements |
None |
retry_achievement_grant |
Retry a failed achievement reward | Changes | write:achievements |
None |
update_achievement_program |
Start, save, pause or resume the achievements program | Changes; waits for approval for starting or resuming the achievements program, which emails members | write:achievements |
Achievements |
Member cards
Printed member cards and their batches.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
delete_blank_card_codes |
Delete blank printed card codes | Waits for approval | write:member-cards |
Member cards |
disable_member_card |
Disable a printed member card | Waits for approval | write:member-cards |
Member cards |
get_card_batch |
Get one card batch with its codes | Reads | read |
Member cards |
issue_member_card |
Generate one printed member card for a member | Changes | write:member-cards |
Member cards |
issue_member_cards |
Generate a batch of printed member cards | Changes | write:member-cards |
Member cards |
list_card_batches |
List printed member card batches | Reads | read |
Member cards |
Referrals
Member referral programs and your business invite code.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
create_referral_program |
Create a member referral program | Changes | write:business |
None |
delete_referral_program |
Delete a member referral program | Waits for approval over MCP | write:business |
None |
get_referral_program |
Get a member referral program | Reads | One of read, write:business |
None |
get_referrals |
Get the business invite code and referred businesses | Reads | read |
Invite businesses |
rename_referral_code |
Rename the business invite code | Changes | write:business |
Invite businesses |
update_referral_program |
Update a member referral program | Changes | write:business |
None |
Business page
Your public business page and contact details.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
get_business_page |
Get the public business page and its settings | Reads | read |
None |
update_business_page |
Update the business page and contact details | Changes | write:business |
None |
Staff
Staff accounts.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
create_staff_member |
Create a new staff member | Changes | write:staff |
None |
delete_staff_member |
Delete a staff member | Waits for approval over MCP | write:staff |
None |
get_staff_member |
Get a specific staff member | Reads | One of read, write:staff |
None |
list_staff |
List all staff members for this partner | Reads | One of read, write:staff |
None |
update_staff_member |
Update an existing staff member | Changes | write:staff |
None |
Support
Your support tickets with the platform owner.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
create_support_ticket |
Open a support ticket with the operator | Changes | write:support |
None |
get_support_ticket |
Get one support ticket with its thread | Reads | read |
None |
list_support_tickets |
List the business's support tickets | Reads | read |
None |
reply_support_ticket |
Reply to a support ticket | Changes | write:support |
None |
Webhooks
Webhook endpoints, delivery metrics, and test sends.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
create_webhook_endpoint |
Create a webhook endpoint | Changes | write:webhooks |
Webhooks |
delete_webhook_endpoint |
Delete a webhook endpoint | Waits for approval | write:webhooks |
Webhooks |
get_webhook_endpoint |
Get one webhook endpoint | Reads | One of read, write:webhooks |
Webhooks |
get_webhook_metrics |
Get webhook delivery metrics | Reads | read |
Webhooks |
list_webhook_endpoints |
List webhook endpoints | Reads | read |
Webhooks |
send_webhook_sample |
Send a sample webhook | Changes; contacts an outside service | write:webhooks |
Webhooks |
send_webhook_test |
Send a test webhook | Changes; contacts an outside service | write:webhooks |
Webhooks |
update_webhook_endpoint |
Update a webhook endpoint | Changes | write:webhooks |
Webhooks |
Integrations
Store connections such as Shopify and WooCommerce.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
disconnect_integration |
Disconnect a store | Waits for approval; contacts an outside service | write:integrations |
None |
get_integration |
Get one store connection | Reads | One of read, write:integrations |
None |
get_integrations_status |
Get the state of the store integrations | Reads | read |
None |
pause_integration |
Pause a store connection | Changes | write:integrations |
None |
redeem_woocommerce_points |
Redeem a member's points for a store coupon | Waits for approval; contacts an outside service | write:integrations |
None |
resume_integration |
Resume a store connection | Changes | write:integrations |
None |
update_integration_settings |
Update a store connection's settings | Changes | write:integrations |
None |
Apple Wallet
Apple Wallet settings for programs.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
check_apple_wallet_sample |
Check a program's Apple Wallet sample pass | Reads | One of read, write:wallet |
Apple Wallet |
get_apple_wallet_item_settings |
Read Apple Wallet settings for one owned loyalty item | Reads | One of read, write:wallet |
None |
update_apple_wallet_item_settings |
Replace Apple Wallet settings for one owned loyalty item | Changes | write:wallet |
None |
Approvals
Check and run the changes you approved.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
execute_approval |
Run an approved change | Runs a change you approved | Any scope that allows changes | None |
get_approval |
Get one approval | Reads | One of write:clubs, write:cards, write:rewards, write:stamps, write:vouchers, write:passes, write:pass-money, write:tiers, write:staff, write:wallet, write:transactions, write:segments, write:campaigns, write:automations, write:achievements, write:member-cards, write:business, write:webhooks, write:integrations, write:support |
None |
list_approvals |
List the approvals this connection prepared | Reads | One of write:clubs, write:cards, write:rewards, write:stamps, write:vouchers, write:passes, write:pass-money, write:tiers, write:staff, write:wallet, write:transactions, write:segments, write:campaigns, write:automations, write:achievements, write:member-cards, write:business, write:webhooks, write:integrations, write:support |
None |
Opening tool families
Opens the tools that are kept in families to keep the tool list small.
| Tool | What it does | Safety | Access | Plan feature |
|---|---|---|---|---|
describe_tool_family |
Describe the tools kept in families | Reads | Any scope; the tool it opens decides | None |
run_family_tool |
Run a tool from a family | Depends on the tool it runs | Any scope; the tool it opens decides | None |
See what your connection has
Ask your AI client to list its tools, or call GET /api/agent/v1/tools?format=mcp with the same key. The Tool discovery page lists the formats.
Some tasks have no tool on purpose: store credentials, installing Shopify, connecting WooCommerce, signing in, creating keys and connections, uploads, downloads, billing checkout, and refunds, holds and other stored-money corrections.
Related topics
- What business owners can ask: example requests, grouped by job.
- Approvals: how risky changes wait for you.
- Limits, errors and retries: what a tool answers when it can't run.