Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| SQUARE_ENVIRONMENT | No | Square API environment ('sandbox' or 'production') | sandbox |
| SQUARE_ACCESS_TOKEN | Yes | Your Square API access token |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| payments | Manage payment operations using Square API Copy Args:
operation: The operation to perform. Valid operations:
Payments:
- list_payments
- create_payment
- get_payment
- update_payment
- cancel_payment
Refunds:
- refund_payment
- list_refunds
- get_refund
Disputes:
- list_disputes
- retrieve_dispute
- accept_dispute
- create_dispute_evidence
Gift Cards:
- create_gift_card
- link_customer_to_gift_card
- retrieve_gift_card
- list_gift_cards
Bank Accounts:
- list_bank_accounts
- get_bank_account
params: Dictionary of parameters for the specific operation |
| terminal | Manage Square Terminal operations Copy Args:
operation: The operation to perform. Valid operations:
Checkout:
- create_terminal_checkout
- search_terminal_checkouts
- get_terminal_checkout
- cancel_terminal_checkout
Devices:
- create_terminal_device
- get_terminal_device
- search_terminal_devices
Refunds:
- create_terminal_refund
- search_terminal_refunds
- get_terminal_refund
- cancel_terminal_refund
params: Dictionary of parameters for the specific operation |
| orders | Manage orders and checkout operations Copy Args:
operation: The operation to perform. Valid operations:
Orders:
- create_order
- batch_retrieve_orders
- calculate_order
- clone_order
- search_orders
- pay_order
- update_order
Checkout:
- create_checkout
- create_payment_link
Custom Attributes:
- upsert_order_custom_attribute
- list_order_custom_attribute_definitions
params: Dictionary of parameters for the specific operation |
| catalog | Manage catalog operations Copy Args:
operation: The operation to perform. Valid operations:
- create_catalog_object
- batch_delete_catalog_objects
- batch_retrieve_catalog_objects
- batch_upsert_catalog_objects
- create_catalog_image
- delete_catalog_object
- retrieve_catalog_object
- search_catalog_objects
- update_catalog_object
- update_item_modifier_lists
- update_item_taxes
params: Dictionary of parameters for the specific operation |
| inventory | Manage inventory operations Copy Args:
operation: The operation to perform. Valid operations:
- batch_change_inventory
- batch_retrieve_inventory_changes
- batch_retrieve_inventory_counts
- retrieve_inventory_adjustment
- retrieve_inventory_changes
- retrieve_inventory_count
- retrieve_inventory_physical_count
- retrieve_inventory_transfer
params: Dictionary of parameters for the specific operation |
| subscriptions | Manage subscription operations Copy Args:
operation: The operation to perform. Valid operations:
- create_subscription
- search_subscriptions
- retrieve_subscription
- update_subscription
- cancel_subscription
- list_subscription_events
- pause_subscription
- resume_subscription
- swap_plan
params: Dictionary of parameters for the specific operation |
| invoices | Manage invoice operations Copy Args:
operation: The operation to perform. Valid operations:
- create_invoice
- search_invoices
- get_invoice
- update_invoice
- cancel_invoice
- publish_invoice
- delete_invoice
params: Dictionary of parameters for the specific operation |
| team | Manage team operations Copy Args:
operation: The operation to perform. Valid operations:
Team Members:
- create_team_member
- bulk_create_team_members
- update_team_member
- retrieve_team_member
- search_team_members
Wages:
- retrieve_wage_setting
- update_wage_setting
Labor:
- create_break_type
- create_shift
- search_shifts
- update_shift
- create_workweek_config
Cash Drawers:
- list_cash_drawer_shifts
- retrieve_cash_drawer_shift
params: Dictionary of parameters for the specific operation |
| customers | Manage customer operations Copy Args:
operation: The operation to perform. Valid operations:
Customers:
- list_customers
- create_customer
- delete_customer
- retrieve_customer
- update_customer
- search_customers
Groups:
- create_customer_group
- delete_customer_group
- list_customer_groups
- retrieve_customer_group
- update_customer_group
Segments:
- list_customer_segments
- retrieve_customer_segment
Custom Attributes:
- create_customer_custom_attribute_definition
- delete_customer_custom_attribute_definition
- list_customer_custom_attribute_definitions
params: Dictionary of parameters for the specific operation |
| loyalty | Manage loyalty operations Copy Args:
operation: The operation to perform. Valid operations:
Programs:
- create_loyalty_program
- retrieve_loyalty_program
Accounts:
- create_loyalty_account
- search_loyalty_accounts
- retrieve_loyalty_account
- accumulate_loyalty_points
- adjust_loyalty_points
- search_loyalty_events
Promotions:
- create_loyalty_promotion
- cancel_loyalty_promotion
params: Dictionary of parameters for the specific operation |
| bookings | Manage booking operations Copy Args:
operation: The operation to perform. Valid operations:
Bookings:
- create_booking
- search_bookings
- retrieve_booking
- update_booking
- cancel_booking
Team Member Bookings:
- bulk_retrieve_team_member_bookings
- retrieve_team_member_booking_profile
Location Profiles:
- list_location_booking_profiles
- retrieve_location_booking_profile
Custom Attributes:
- create_booking_custom_attribute_definition
- update_booking_custom_attribute_definition
params: Dictionary of parameters for the specific operation |
| business | Manage business operations Copy Args:
operation: The operation to perform. Valid operations:
Merchants:
- list_merchants
- retrieve_merchant
Locations:
- list_locations
- create_location
- retrieve_location
- update_location
Vendors:
- bulk_create_vendors
- bulk_retrieve_vendors
- create_vendor
- search_vendors
- update_vendor
Sites:
- list_sites
params: Dictionary of parameters for the specific operation |