Square Model Context Protocol Server (Beta)
About
# Square Model Context Protocol Server (Beta) This project follows the [Model Context Protocol](https://modelcontextprotocol.com/) standard, allowing AI assistants to interact with Square's connect API. ## Quick Start Get up and running with the Square MCP server using npx: ```bash # Basic startup npx…
Details
- License
- Apache-2.0 license
Explore
- Three core tools: get_service_info, get_type_info, and make_api_request
- Access to Square’s complete API ecosystem (40+ services)
- Supports both local (access token) and remote (OAuth) authentication
- Sandbox and production environment switching via environment variables
- Read-only mode available with DISALLOW_WRITES=true
- Remote MCP server hosted at mcp.squareup.com/sse
Setting up with Highlight
This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:
- Download and install Highlight from highlightai.com/download
- Navigate to the plugins tab and select "Add Custom Plugin"
-
Configure the plugin with the settings below
Plugin Name
Square Model Context Protocol Server (Beta)Command (node, npx, python, etc.)Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
- Enable "Start Automatically" if you want the plugin to start when Highlight launches
From the repository
Get up and running with the Square MCP server using npx:
ACCESS_TOKEN=YOUR_SQUARE_ACCESS_TOKEN SANDBOX=true npx square-mcp-server start
| 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 |
npx square-mcp-server install
npx square-mcp-server get-goose-url
The install command automatically updates your Goose configuration.
For optimal interaction with the Square API through MCP:
1. Discover: Use get_service_info to explore available methods
get_service_info(service: "catalog")
2. Understand: Use get_type_info to learn parameter requirements
get_type_info(service: "catalog", method: "list")
3. Execute: Use make_api_request to perform the operation
make_api_request(service: "catalog", method: "list", request: {})
make_api_request
Unified tool for all Square API operations. Be sure to get types before calling. Available services: applepay, bankaccounts, bookingcustomattributes, bookings, cards, cashdrawers, catalog, checkout, customercustomattributes, customergroups, customersegments, customers, devices, disputes, events, giftcardactivities, giftcards, inventory, invoices, labor, locationcustomattributes, locations, loyalty, merchantcustomattributes, merchants, oauth, ordercustomattributes, orders, payments, payouts, refunds, sites, snippets, subscriptions, team, terminal, vendors, webhooksubscriptions.
get_type_info
Get type information for a Square API method. You must call this before calling the make_api_request tool.
get_service_info
Get information about a Square API service. Call me before trying to get type info
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 |
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"square model context protocol server (beta)": {
"square-mcp-server-mikeysrecipes": {
"command": "npx",
"args": [
"square-mcp-server",
"start"
]
}
}
}
}McpServers
{
"square-mcp-server-mikeysrecipes": {
"command": "npx",
"args": [
"square-mcp-server",
"start"
]
}
}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:
```bash
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
