Square Server
Overview
The Square server provides point-of-sale and business management capabilities. Built by Square, this server enables AI assistants to manage payment processing, inventory management, customer relationships, invoicing, bookings, and complete commerce operations through Square’s comprehensive API.Getting Started
1
Connect to Square
Add the Square server to your Nexus environment through the server directory.
2
Authenticate with Square
On the Nexus Chat tab, ask to retrieve your business details on Square.
An Authorization pop-up will appear, guiding you through the OAuth login process.
3
Test Connection
Once you have logged in, Nexus will fetch your Square business information and display it.
What You Can Do
Business Management
Access and manage your Square business account details and settings
Product Catalog
List, create, update, and manage products in your Square catalog
Order Management
View and manage orders, track sales, and process transactions
Sales Reports
Generate detailed sales reports and analyze business performance
Use Cases
Business Operations
Business Operations
- Account Details: Retrieve your business information and account settings
- Business Insights: Access key business metrics and performance data
- Location Management: View and manage multiple business locations
- Configuration: Access and update business configuration settings
Product & Catalog Management
Product & Catalog Management
- Product Listing: View all products in your Square catalog
- Inventory Management: Track product inventory and availability
- Catalog Updates: Add new products or update existing product details
- Pricing Management: Manage product pricing and variations
Order & Transaction Management
Order & Transaction Management
- Order Tracking: View all orders from today or specific time periods
- Transaction History: Access detailed transaction records
- Order Details: Get comprehensive information about specific orders
- Payment Processing: Track payment status and methods
Sales Analytics
Sales Analytics
- Sales Reports: Generate monthly, weekly, or custom date range sales reports
- Performance Metrics: Analyze sales trends and business performance
- Revenue Tracking: Monitor revenue across products and time periods
- Business Intelligence: Get insights into top-performing products and services
Available Tools (3)
get_service_info
get_service_info
CALL THIS FIRST before trying to get type info. Get information about a Square API service category and its available methods.
- Input:
service- The Square API service category (e.g., ‘catalog’, ‘payments’, ‘customers’, ‘inventory’) - Returns: Available methods and service details for the specified Square API service category
- Use Cases: Discover what operations are available in a service before making requests
get_type_info
get_type_info
Get request and response schema for a specific Square API method. You must call this before calling make_api_request.
- Input:
service- The Square API service category (e.g., ‘catalog’, ‘payments’)method- The API method to call (e.g., ‘list’, ‘create’)
- Returns: Request and response schema for the specified API method
- Use Cases: Understand required parameters and response format before making API calls
make_api_request
make_api_request
Unified tool for all Square API operations. Be sure to get types before calling.
-
Input:
service(required) - The Square API service categorymethod(required) - The API method to callrequest(optional) - JSON object with required parameters for the methodcharacterization(optional) - Brief description of business intent (e.g., ‘Processing customer payment’, ‘Adding inventory item’, ‘Generating sales report’) - Do not pass PII
-
Available Services (40+ services):
- Payments: applepay, cards, payments, refunds, disputes
- Catalog: catalog, inventory
- Customers: customers, customergroups, customersegments, customercustomattributes
- Orders: orders, ordercustomattributes
- Invoices: invoices
- Bookings: bookings, bookingcustomattributes
- Locations: locations, locationcustomattributes, devices
- Team: team, labor
- Loyalty: loyalty, giftcards, giftcardactivities
- Merchants: merchants, merchantcustomattributes
- Financial: bankaccounts, payouts, cashdrawers
- Integrations: webhooksubscriptions, events, sites, snippets
- Commerce: checkout, subscriptions, terminal, vendors
- Best Practice: Always call get_service_info first, then get_type_info before making API requests
The Square server provides a comprehensive wrapper around Square’s REST API, enabling full access to Square’s business management capabilities through natural language interactions.
Configuration Requirements
Authentication Setup
The Square server uses OAuth2 authentication with Square’s API:OAuth Scopes
OAuth Scopes
Required Scopes for Full Functionality:
- Business Information: Read access to business account details
- Catalog: Read/write access to product catalog
- Orders: Read access to orders and transactions
- Payments: Read access to payment information
- Reports: Access to sales reports and analytics
Account Requirements
Account Requirements
- Square Account: Active Square business account (free or paid)
- API Access: Ensure API access is enabled for your account
- Permissions: Appropriate role permissions for accessing business data
- Rate Limits: Be aware of API rate limits based on your account tier
Best Practices
API Usage
- Service Discovery: Use
get_service_infofirst to understand available operations - Type Understanding: Use
get_type_infoto understand data structures before requests - Efficient Requests: Request only the data you need to minimize API usage
- Error Handling: Handle API errors gracefully and respect rate limits
Business Operations
- Read First: Fetch current state before making updates to business data
- Validation: Validate data formats and requirements before creating or updating resources
- Testing: Test operations with read-only requests before making changes
- Monitoring: Regularly check sales reports and analytics for business insights
Pro Tip: Start by retrieving your business details and exploring your catalog before attempting to make changes. This helps you understand your current Square setup and available data.