Skip to content
Back to search

square-mcp-server

A Model Context Protocol (MCP) server for square

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/square--square-mcp-server/badge.svg)](/listings/square--square-mcp-server)

HTML

<a href="/listings/square--square-mcp-server"><img src="/api/listings/square--square-mcp-server/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

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](https://developer.squareup.com/docs/build-basics/access-tokens). You can also set environment variables before running the command.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 205 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. # Square Model Context Protocol Server (Beta)
  2. This project follows the [Model Context Protocol](https://modelcontextprotocol.com/) standard, allowing AI assistants to interact with Square's connect API.
  3. > **Most people should use the hosted server.** Square runs a remote MCP server at `https://mcp.squareup.com/mcp` with OAuth sign-in; see the [Square MCP documentation](https://developer.squareup.com/docs/mcp) for setup with your AI assistant. This repository is the local, self-hosted server: a starting point if you want to run your own copy. Code changes go through the generator described under Contributing.
  4. <a href="https://glama.ai/mcp/servers/@square/square-mcp-server">
  5. <img width="380" height="200" src="https://glama.ai/mcp/servers/@square/square-mcp-server/badge" alt="Square Model Context Protocol Server MCP server" />
  6. </a>
  7. ## Quick Start
  8. Get up and running with the local server using npx. This runs the server on your own machine with your own access token; for the hosted server, see the note above.
  9. ```bash
  10. # Basic startup
  11. npx square-mcp-server start
  12. # With environment configuration
  13. ACCESS_TOKEN=YOUR_SQUARE_ACCESS_TOKEN SANDBOX=true npx square-mcp-server start
  14. # local runs
  15. npx /path/to/project/square-mcp-server
  16. ```
  17. 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](https://developer.squareup.com/docs/build-basics/access-tokens). You can also set environment variables before running the command.
  18. ## Remote MCP Server
  19. Square offers a hosted remote MCP server at:
  20. ```
  21. https://mcp.squareup.com/mcp
  22. ```
  23. The remote server is recommended: it uses OAuth, so you sign in with your Square account instead of creating and managing access tokens. Setup guides for Claude, ChatGPT, Goose and other assistants are in the [Square MCP documentation](https://developer.squareup.com/docs/mcp). The older `https://mcp.squareup.com/sse` endpoint is still served for existing SSE configurations.
  24. ## Configuration Options
  25. | Environment Variable | Purpose | Example |
  26. |---------------------|---------|---------|
  27. | `ACCESS_TOKEN` | Your Square API access token | `ACCESS_TOKEN=sq0atp-...` |
  28. | `SANDBOX` | Use Square sandbox environment | `SANDBOX=true` |
  29. | `PRODUCTION` | Use Square production environment | `PRODUCTION=true` |
  30. | `DISALLOW_WRITES` | Restrict to read-only operations | `DISALLOW_WRITES=true` |
  31. | `SQUARE_VERSION` | Specify Square API version | `SQUARE_VERSION=2025-04-16` |
  32. ## Integration with AI Assistants
  33. ### Goose Integration
  34. To configure the Square MCP Server with [Goose](https://block.github.io/goose/):
  35. #### Remote MCP
  36. To install the Square remote MCP in Goose, click this URL on a computer where Goose is installed:
  37. [goose://extension?cmd=npx&arg=mcp-remote&arg=https%3A%2F%2Fmcp.squareup.com%2Fmcp&id=square_mcp_production_remote&name=Square%20MCP%20Remote&description=Square%20Production%20MCP%20Remote](goose://extension?cmd=npx&arg=mcp-remote&arg=https%3A%2F%2Fmcp.squareup.com%2Fmcp&id=square_mcp_production_remote&name=Square%20MCP%20Remote&description=Square%20Production%20MCP%20Remote)
  38. Or copy and paste the URL into your browser's address bar.
  39. The commands below configure the local server (`npx square-mcp-server start`), not the hosted one:
  40. ```bash
  41. # Automatic installation
  42. npx square-mcp-server install
  43. # Get URL for manual installation
  44. npx square-mcp-server get-goose-url
  45. ```
  46. The `install` command automatically updates your Goose configuration.
  47. ### Claude Desktop Integration
  48. For Claude Desktop integration, see the [Model Context Protocol Quickstart Guide](https://modelcontextprotocol.io/quickstart/user). Add this configuration to your `claude_desktop_config.json`:
  49. #### Remote MCP
  50. ```json
  51. {
  52. "mcpServers": {
  53. "mcp_square_api": {
  54. "command": "npx",
  55. "args": ["mcp-remote", "https://mcp.squareup.com/mcp"]
  56. }
  57. }
  58. }
  59. ```
  60. This approach allows you to authenticate directly with your Square account credentials without needing to manage access tokens.
  61. #### Local MCP
  62. ```json
  63. {
  64. "mcpServers": {
  65. "mcp_square_api": {
  66. "command": "npx",
  67. "args": ["square-mcp-server", "start"],
  68. "env": {
  69. "ACCESS_TOKEN": "YOUR_SQUARE_ACCESS_TOKEN",
  70. "SANDBOX": "true"
  71. }
  72. }
  73. }
  74. }
  75. ```
  76. ## Tool Reference
  77. The Square MCP Server provides a streamlined set of tools for interacting with Square APIs:
  78. | Tool | Description | Primary Use |
  79. |------|-------------|------------|
  80. | `get_service_info` | Discover methods available for a service | Exploration and discovery |
  81. | `get_type_info` | Get detailed parameter requirements | Request preparation |
  82. | `make_api_request` | Execute API calls to Square | Performing operations |
  83. ## Service Catalog
  84. Square MCP Server provides access to Square's complete [API ecosystem](https://developer.squareup.com/reference/square). Check out the [Square API Documentation](https://developer.squareup.com/docs) for detailed information about each service:
  85. | Service | Description |
  86. |---------|-------------|
  87. | `applepay` | Apple Pay integration |
  88. | `bankaccounts` | Bank account management |
  89. | `bookingcustomattributes` | Custom attributes for bookings |
  90. | `bookings` | Appointment booking management |
  91. | `cards` | Payment card management |
  92. | `cashdrawers` | Cash drawer management |
  93. | `catalog` | Catalog management (items, categories, etc.) |
  94. | `checkout` | Checkout and payment processing |
  95. | `customercustomattributes` | Custom attributes for customers |
  96. | `customergroups` | Customer grouping |
  97. | `customersegments` | Customer segmentation |
  98. | `customers` | Customer management |
  99. | `devices` | Square device management |
  100. | `disputes` | Payment dispute handling |
  101. | `events` | Event tracking |
  102. | `giftcardactivities` | Gift card activity tracking |
  103. | `giftcards` | Gift card management |
  104. | `inventory` | Inventory tracking |
  105. | `invoices` | Invoice management |
  106. | `labor` | Workforce management |
  107. | `locationcustomattributes` | Custom attributes for locations |
  108. | `locations` | Location management |
  109. | `loyalty` | Loyalty program management |
  110. | `merchantcustomattributes` | Custom attributes for merchants |
  111. | `merchants` | Merchant account management |
  112. | `oauth` | Authentication |
  113. | `ordercustomattributes` | Custom attributes for orders |
  114. | `orders` | Order management |
  115. | `payments` | Payment processing |
  116. | `payouts` | Payout management |
  117. | `refunds` | Refund management |
  118. | `sites` | Website integration |
  119. | `snippets` | Square Online Code integration |
  120. | `subscriptions` | Subscription management |
  121. | `team` | Staff management |
  122. | `terminal` | Square Terminal management |
  123. | `vendors` | Supplier management |
  124. | `webhooksubscriptions` | Event notifications |
  125. ## Usage Pattern
  126. For optimal interaction with the Square API through MCP:
  127. 1. **Discover**: Use `get_service_info` to explore available methods
  128. ```
  129. get_service_info(service: "catalog")
  130. ```
  131. 2. **Understand**: Use `get_type_info` to learn parameter requirements
  132. ```
  133. get_type_info(service: "catalog", method: "list")
  134. ```
  135. 3. **Execute**: Use `make_api_request` to perform the operation
  136. ```
  137. make_api_request(service: "catalog", method: "list", request: {})
  138. ```
  139. ## Development and Debugging
  140. ### Using MCP Inspector
  141. The [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector) provides a visual interface for testing:
  142. ```bash
  143. # Build the project
  144. npm run build
  145. # Start the inspector with the Square MCP Server
  146. npx @modelcontextprotocol/inspector node dist/index.js start
  147. ```
  148. ### Development Workflow
  149. 1. Clone the repository
  150. 2. Install dependencies: `npm install`
  151. 3. Start development mode: `npm run watch`
  152. 4. Run the server: `node dist/index.js start`
  153. 5. Test your changes using the MCP Inspector
  154. ## Contributing
  155. 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.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.