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:

# Basic startup
npx square-mcp-server start

# With environment configuration
ACCESS_TOKEN=YOUR_SQUARE_ACCESS_TOKEN SANDBOX=true npx square-mcp-server start

# local runs
npx /path/to/project/square-mcp-server

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.

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:

# Automatic installation
npx square-mcp-server install

# Get URL for manual installation
npx square-mcp-server get-goose-url

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:

{
  "mcpServers": {
    "mcp_square_api": {
      "command": "npx",
      "args": [
        "square-mcp-server",
        "start"
      ],
      "env": {
        "ACCESS_TOKEN": "YOUR_SQUARE_ACCESS_TOKEN",
        "SANDBOX": "true"
      }
    }
  }
}

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: