Square MCP Server

The Square MCP service is a project that follows the Model Context Protocol standard, providing an interface for interacting with the Square Connect API, supporting quick startup, multi-environment configuration, and integration with mainstream AI assistants.

E-commerce and retail Artificial intelligence chatbots #Payment Interface #AI Integration #Business Services .TypeScript

rating : 2.5 points

downloads : 7.9K

update time : 2025-04-28

Open Site

What is the Square MCP Server?

This is a service that follows the Model Context Protocol standard and serves as a bridge between AI assistants and the Square e-commerce platform. It simplifies the interaction process between AI and the Square API, allowing non-technical users to manage e-commerce businesses through natural language.

How to use the Square MCP service?

Simply configure your AI assistant (such as Claude or Goose), and the service will automatically handle the complex interactions with the Square API. You can manage information such as products, orders, and customers through natural language instructions.

Applicable scenarios

Suitable for e-commerce store owners to manage Square stores through AI assistants, including daily operation scenarios such as inventory query, order processing, and customer relationship management.

Main features

Square API Gateway

Provides a secure access channel to all Square APIs, including more than 50 services such as payment, inventory, and customer management.

AI-Optimized Interface

A simplified protocol designed specifically for AI interaction that automatically handles complex API parameters and authentication processes.

Service Discovery

Built-in API exploration tool to help AI understand available Square functions.

Advantages

Manage Square stores through AI without programming

Unified interface supports all Square functions

Automatically handle complex authentication processes such as OAuth

Built-in sandbox environment for easy testing

Limitations

Requires a basic Square developer account

Advanced functions still require understanding of API documentation

Response speed depends on Square servers

How to use

Get a Square access token

Create an application on the Square developer platform and obtain an API access token.

Install the service

Install the MCP server with one click using npm.

Configure the AI assistant

Add the server URL to your AI assistant configuration.

Usage examples

Query the product catalog

Let the AI assistant list all products in the store

Process a refund

Process a customer refund request through an AI instruction

Frequently Asked Questions

Is it necessary to pay for use?

Which AI assistants are supported?

Related resources

Square Developer Documentation

Official Square API reference documentation

MCP Protocol Official Website

Model Context Protocol standard documentation

🚀 Square Model Context Protocol Server (Beta Version)

This project adheres to the Model Context Protocol standard, enabling AI assistants to interact with Square's connection API.

🚀 Quick Start

Use npx to quickly start the Square MCP server:

# Basic startup
npx square-mcp-server start

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

# Start in development mode
npm run dev

Configuration Options

Here are the available environment variables and their purposes:

Environment Variable	Purpose	Example Value
`ACCESS_TOKEN`	Access token for the Square API	"your_access_token"
`SANDBOX`	Enable sandbox mode (for development and testing)	true
`PORT`	Port on which the server runs	3000

Install Dependencies

To install the project's required dependencies, run the following command:

npm install

✨ Features

The Square MCP server provides the following core features:

Service Information Discovery: Discover available services through the get_service_info method.
Type Information Retrieval: Use the get_type_info method to obtain detailed information about a specific service.
API Request Execution: Execute actual API operations using the make_api_request method.

💻 Usage Examples

Basic Usage

1. Discover Service Information

get_service_info(service: "catalog")

2. Retrieve Type Information

get_type_info(service: "catalog", method: "list")

3. Execute an API Request

make_api_request(service: "catalog", method: "list", request: {})

🔧 Development and Debugging

Use the MCP Inspector

To assist with development and debugging, you can use the MCP Inspector:

# Build the project
npm run build

# Start the inspector
npx @modelcontextprotocol/inspector node dist/index.js start

Development Process

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.

🤝 Contribution Guidelines

This repository is automatically generated based on Square's OpenAPI specification. While contributions are welcome, please note that any changes need to be integrated into the generator of the generated code. Before submitting a pull request, please open an issue to discuss the proposed changes.

If you have any questions or need further assistance, please feel free to contact the project maintainers.