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.
Square Model Context Protocol Server (Beta)
This project follows the Model Context Protocol standard, allowing AI assistants to interact with Square's connect API.
Quick Start
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.
Remote MCP Server
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.
Configuration Options
Environment Variable | Purpose | Example |
---|---|---|
ACCESS_TOKEN | Your Square API access token | ACCESS_TOKEN=sq0atp-... |
SANDBOX | Use Square sandbox environment | SANDBOX=true |
PRODUCTION | Use Square production environment | PRODUCTION=true |
DISALLOW_WRITES | Restrict to read-only operations | DISALLOW_WRITES=true |
SQUARE_VERSION | Specify Square API version | SQUARE_VERSION=2025-04-16 |
Integration with AI Assistants
Goose Integration
To configure the Square MCP Server with Goose:
Remote MCP
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.
Claude Desktop Integration
For Claude Desktop integration, see the Model Context Protocol Quickstart Guide. Add this configuration to your claude_desktop_config.json
:
Remote MCP
This approach allows you to authenticate directly with your Square account credentials without needing to manage access tokens.
Local MCP
Tool Reference
The Square MCP Server provides a streamlined set of tools for interacting with Square APIs:
Tool | Description | Primary Use |
---|---|---|
get_service_info | Discover methods available for a service | Exploration and discovery |
get_type_info | Get detailed parameter requirements | Request preparation |
make_api_request | Execute API calls to Square | Performing operations |
Service Catalog
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 |
---|---|
applepay | Apple Pay integration |
bankaccounts | Bank account management |
bookingcustomattributes | Custom attributes for bookings |
bookings | Appointment booking management |
cards | Payment card management |
cashdrawers | Cash drawer management |
catalog | Catalog management (items, categories, etc.) |
checkout | Checkout and payment processing |
customercustomattributes | Custom attributes for customers |
customergroups | Customer grouping |
customersegments | Customer segmentation |
customers | Customer management |
devices | Square device management |
disputes | Payment dispute handling |
events | Event tracking |
giftcardactivities | Gift card activity tracking |
giftcards | Gift card management |
inventory | Inventory tracking |
invoices | Invoice management |
labor | Workforce management |
locationcustomattributes | Custom attributes for locations |
locations | Location management |
loyalty | Loyalty program management |
merchantcustomattributes | Custom attributes for merchants |
merchants | Merchant account management |
oauth | Authentication |
ordercustomattributes | Custom attributes for orders |
orders | Order management |
payments | Payment processing |
payouts | Payout management |
refunds | Refund management |
sites | Website integration |
snippets | Square Online Code integration |
subscriptions | Subscription management |
team | Staff management |
terminal | Square Terminal management |
vendors | Supplier management |
webhooksubscriptions | Event notifications |
Usage Pattern
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
Development and Debugging
Using MCP Inspector
The MCP Inspector provides a visual interface for testing:
Development Workflow
- 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
Contributing
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.
- Quick Start
- Remote MCP Server
- Configuration Options
- Integration with AI Assistants
- Tool Reference
- Service Catalog
- Usage Pattern
- Development and Debugging
- Contributing
Related Resources
Related MCP Servers
- AsecurityFlicenseAqualityImplements the Model Context Protocol to allow AI models to access and interact with blockchain data, including reading contract states, retrieving events, and accessing transaction information across various networks.Last updated -104530TypeScript
- -security-license-qualityA Model Context Protocol server implementation that enables AI assistants to interact with Linear project management systems, allowing them to create, retrieve, and modify data related to issues, projects, teams, and users.Last updated -202TypeScript
- -securityFlicense-qualityEnables AI models to interact with Linear for issue tracking and project management through the Model Context Protocol, supporting capabilities like creating issues, searching, managing sprints, and bulk updating statuses.Last updated -5TypeScript
lightfast-mcpofficial
-securityAlicense-qualityConnects creative applications like Blender and Adobe Creative Suite to AI models through the Model Context Protocol, enabling AI-driven creation, manipulation, and automation within these tools.Last updated -4PythonMIT License