The Square Model Context Protocol Server enables AI assistants to interact with Square's API ecosystem. With this server, you can:
Execute API Operations: Use make_api_request to perform operations across Square services like catalog, payments, customers, orders, invoices, and inventory.
Discover API Methods: Use get_service_info to explore available methods within specific Square API services.
Understand API Requirements: Use get_type_info to learn parameter requirements for specific API methods.
Configure Flexibly: Set up with environment variables for access tokens, environment (sandbox/production), write restrictions, and API version.
Deploy Options: Run locally via npx or connect to a hosted remote version with OAuth authentication.
Integrate with AI: Works seamlessly with AI assistants like Goose and Claude Desktop.
Enables integration with Apple Pay through Square's API, allowing for payment processing via Apple's payment platform.
Provides access to Square's complete API ecosystem, enabling interactions with services such as catalog management, customer management, payment processing, order management, inventory tracking, appointment booking, gift cards, loyalty programs, and many other Square business services.
This project follows the Model Context Protocol standard, allowing AI assistants to interact with Square's connect API.
Get up and running with the Square MCP server using npx:
Replace YOUR_SQUARE_ACCESS_TOKEN with your actual Square access token. You can obtain your access token by following the guide at Square Access Tokens. You can also set environment variables before running the command.
Square now offers a hosted remote MCP server at:
The remote MCP is recommended as it uses OAuth authentication, allowing you to log in with your Square account directly without having to create or manage access tokens manually.
Environment Variable | Purpose | Example |
| Your Square API access token |
|
| Use Square sandbox environment |
|
| Use Square production environment |
|
| Restrict to read-only operations |
|
| Specify Square API version |
|
To configure the Square MCP Server with Goose:
To install the Square remote MCP in Goose, click this URL on a computer where Goose is installed:
Or copy and paste the URL into your browser's address bar.
The install command automatically updates your Goose configuration.
For Claude Desktop integration, see the Model Context Protocol Quickstart Guide. Add this configuration to your claude_desktop_config.json:
This approach allows you to authenticate directly with your Square account credentials without needing to manage access tokens.
The Square MCP Server provides a streamlined set of tools for interacting with Square APIs:
Tool | Description | Primary Use |
| Discover methods available for a service | Exploration and discovery |
| Get detailed parameter requirements | Request preparation |
| Execute API calls to Square | Performing operations |
Square MCP Server provides access to Square's complete API ecosystem. Check out the Square API Documentation for detailed information about each service:
Service | Description |
| Apple Pay integration |
| Bank account management |
| Custom attributes for bookings |
| Appointment booking management |
| Payment card management |
| Cash drawer management |
| Catalog management (items, categories, etc.) |
| Checkout and payment processing |
| Custom attributes for customers |
| Customer grouping |
| Customer segmentation |
| Customer management |
| Square device management |
| Payment dispute handling |
| Event tracking |
| Gift card activity tracking |
| Gift card management |
| Inventory tracking |
| Invoice management |
| Workforce management |
| Custom attributes for locations |
| Location management |
| Loyalty program management |
| Custom attributes for merchants |
| Merchant account management |
| Authentication |
| Custom attributes for orders |
| Order management |
| Payment processing |
| Payout management |
| Refund management |
| Website integration |
| Square Online Code integration |
| Subscription management |
| Staff management |
| Square Terminal management |
| Supplier management |
| Event notifications |
For optimal interaction with the Square API through MCP:
Discover: Use get_service_info to explore available methods
Understand: Use get_type_info to learn parameter requirements
Execute: Use make_api_request to perform the operation
The MCP Inspector provides a visual interface for testing:
Clone the repository
Install dependencies: npm install
Start development mode: npm run watch
Run the server: node dist/index.js start
Test your changes using the MCP Inspector
This repository is auto-generated from Square's OpenAPI Specification. While contributions are welcome, please note that changes will need to be incorporated into the generator that produces this code. Please open an issue to discuss proposed changes before submitting a pull request.
hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
Enables AI assistants to interact with Square's Connect API through the Model Context Protocol standard, allowing for operations like managing customers, processing payments, and handling inventory.
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/square/square-mcp-server'
If you have feedback or need assistance with the MCP directory API, please join our Discord server