How to Use the Square MCP in Claude Code

Q: Can I use Claude Code to get payment details from Square?

Yep. You run a command that calls getpaymentdetails, passing in the transaction ID. The output is clean JSON, ready for another shell script to consume.

Q: If I need to list multiple payments using Claude Code and Square?

Use the listpayments tool with pagination flags. This ensures your terminal job pulls every payment record without you having to manually manage page tokens.

Q: How do I search for customers in bulk with Claude Code and Square?

You'll run a script that calls searchcustomers, passing the required criteria. The output is machine-readable, which lets you pipe the results directly into another processing tool.

Automate Square reporting pipelines from the terminal using Claude Code.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers — Included with Plan

Connect Square MCP to Claude Code

Create your Vinkius account to connect Square to Claude Code — we handle the hosting, security, and runtime updates so you don't have to. No server setup required.

GDPR Included with Plan

Setup Square with Claude Code

Ask AI about this MCP

ChatGPT

Claude

Perplexity Vinkius runs on Gemini

Gemini

Grok

Batch Process Customer Data Retrieval

Need to pull a list of customers for compliance? Run a single command that calls `list_customers`, and pipe the output directly into a CSV file. No GUI means no fluff, just raw data you can use instantly. You can then take those IDs and run `get_customer` on them in a script loop, making it perfect for scheduled reporting jobs.

Automated Payment History Audit

Running an audit? Start by listing all payments using `list_payments`. Since this supports pagination, your command handles the entire dataset—no matter how many pages there are. You can then pipe this massive list to a tool that analyzes specific payment types or dates for month-end closing.

Inventory Synchronization for CI/CD

Build a pipeline step that validates stock levels before deployment. Run `get_stock_count` against your primary item list via command line. This makes sure the inventory data is accurate before any code hits production. The output can be checked by subsequent scripts, making it reliable for automated checks.

Setup guide

Set up Square MCP in Claude Code

Prerequisites

Claude Code CLI installed (npm install -g @anthropic-ai/claude-code)
Active Vinkius subscription with a valid endpoint token

1

Run the add command

Open your terminal and run the command shown on the right. Replace [YOUR_TOKEN_HERE] with your endpoint token from cloud.vinkius.com. Use --scope user to make it available across all projects.
2

Verify the connection

Start a Claude Code session and type /mcp to list connected servers. You should see square-alternative-mcp with a green status indicator.
3

Start using tools

Ask Claude Code something like "Check my latest Square transactions." It will automatically discover and invoke the available Square tools.

Terminal

claude mcp add --transport http square-alternative-mcp https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp

Get your connection token →

Prerequisites

Claude Code CLI installed
Active Vinkius subscription with a valid endpoint token

1

Open the config file

Create or edit .mcp.json in your project root for project-level scope, or ~/.claude.json for user-level scope.
2

Add the Square MCP

Paste the JSON snippet shown on the right into the mcpServers object. Replace [YOUR_TOKEN_HERE] with your endpoint token from cloud.vinkius.com.
3

Restart Claude Code

Start a new Claude Code session. Type /mcp to confirm the server is connected. The tools will be automatically available in your conversation.

.mcp.json

{
  "mcpServers": {
    "square-alternative-mcp": {
      "type": "url",
      "url": "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
    }
  }
}

Get your connection token →

Independent Platform Disclaimer: Vinkius is an independent platform and is not affiliated with, endorsed by, sponsored by, verified by, or otherwise authorized by Square. All third-party trademarks, logos, and brand names are the property of their respective owners. Their use on this website is strictly for informational purposes to identify service compatibility and interoperability.

Why Choose Vinkius

Vinkius connects your tools to AI with real-time monitoring and automatic cost savings — all from one dashboard.

Connect Square now

Real-time monitoring

Live

visibility into every interaction

Connect your favorite tools to your AI and see exactly what's happening — every request, every response, in real time.

Built-in savings

60%

lower AI costs

Vinkius compresses data between your apps and your AI automatically. Lower bills every month — no configuration required.

Single dashboard

One

place for every integration

Every tool your AI connects to, managed from a single screen. One account, complete control.

Common questions about Square MCP in Claude Code

You execute the command in your shell environment. The MCP Server handles authentication, so you just point the terminal at the required tool (like `get_order_details`) and it runs headless.

Yep. You run a command that calls `get_payment_details`, passing in the transaction ID. The output is clean JSON, ready for another shell script to consume.

Use the `list_payments` tool with pagination flags. This ensures your terminal job pulls every payment record without you having to manually manage page tokens.

Your commands touch customer names, order metadata, and payment records. Always ensure the service account credentials used by your CI/CD pipeline only have read access to what they absolutely need.

You'll run a script that calls `search_customers`, passing the required criteria. The output is machine-readable, which lets you pipe the results directly into another processing tool.

Use it with your favorite AI tools

Connect this server to Cursor, Claude, VS Code, and more.

OpenAI Agents SDK sdk-python

Google ADK sdk-python

Pydantic AI sdk-python

Vercel AI SDK sdk-typescript