square

The Square MCP Server provides a Model Context Protocol interface to interact with Square's API. It exposes a concise set of tools that let you discover available Square services, inspect the required parameters for operations, and execute API calls against Square endpoints. Start the server locally with npx square-mcp-server start, ensuring you supply your Square access token and optional environment flags to switch between sandbox and production modes. Once running, you can remotely connect to this MCP server from compatible AI assistants to perform Square operations such as catalog management, payments, customers, orders, and more through the MCP tooling layer.

To use the tools, begin by discovering capabilities with get_service_info, which returns available methods for a given Square service (for example, catalog or orders). Then fetch parameter requirements for a specific method with get_type_info to understand required inputs. Finally, execute an operation via make_api_request by providing the service, method, and a structured request payload. This workflow enables exploratory testing and precise operation execution against Square APIs through the MCP bridge.

Prerequisites:

• Node.js (LTS) and npm installed
• Access token from Square (and optional sandbox flag)

1. Install Node.js and npm if not already installed. For most systems:

   • macOS: brew install node
   • Windows: use the Node.js installer from nodejs.org
   • Linux: use your distribution's package manager (e.g., apt, yum) or nvm

2. Install dependencies (if you are configuring locally from source):

npm install

3. Run the Square MCP server locally using npx (no global install required):

# Basic startup (requires config in environment or default behavior)
npx square-mcp-server start

# With environment configuration (recommended for quick setup)
ACCESS_TOKEN=YOUR_SQUARE_ACCESS_TOKEN SANDBOX=true npx square-mcp-server start

4. Alternative remote host setup (if you prefer using the hosted remote server):

# No local token management needed when using remote MCP (OAuth-based)
# See the Quick Start for the hosted endpoint at https://mcp.squareup.com/sse

5. Optional: integrate with AI assistants or clients by pointing them at the MCP server endpoint and using the provided tools (get_service_info, get_type_info, make_api_request).

Tips and caveats:

• Keep your Square access token secure; prefer sandbox mode for development by setting SANDBOX=true until you are ready for production.
• If DISALLOW_WRITES is set to true, write operations (POST/PUT/DELETE) will be restricted; use this for read-only testing.
• You can override the Square API version with SQUARE_VERSION to pin to a specific release.
• The remote MCP at https://mcp.squareup.com/sse supports OAuth authentication; consider using it to avoid managing access tokens locally.
• When integrating with Goose or Claude Desktop, you can either point to the remote MCP or run a local instance and provide the appropriate command-and-args along with an env block for credentials.
• If you encounter connectivity issues, verify that your environment variables are exported in the shell that launches the MCP server and that your network allows outbound connections to Square endpoints.