square/square-mcp-server

Developer tools

このページは AI により自動翻訳されています。技術的な詳細は原文をご確認ください。原文を見る

109 stars 27 forks 品質 84 トレンド 29Apache-2.0

Repository Install

square/square-mcp-serverは、https://github.com/square/square-mcp-server.からインポートされたMCPサーバー候補です。

概要

square/square-mcp-serverは、https://github.com/square/square-mcp-server.からインポートされたMCPサーバー候補です。

概要（AI 翻訳）

このプロジェクトはModel Context Protocol標準に準拠しており、AIアシスタントがSquareのConnect APIとやり取りできるようにします。

ほとんどの人はホストサーバーを使うべきです。 SquareはOAuthサインインでhttps://mcp.squareup.com/mcpにリモートMCPサーバーを運用しています。AIアシスタントでセットアップするにはSquare MCPのドキュメントを参照してください。このリポジトリはローカルのセルフホストサーバーであり、自分でコピーを実行したい場合の出発点となります。コードの変更は、Contributingで説明されているジェネレーターを経由します。

クイックスタート

npxを使ってローカルサーバーを起動します。これにより、自分のマシン上でアクセストークンでサーバーを稼働させます。ホストサーバーについては、上記の注記を参照してください。

YOUR_SQUARE_ACCESS_TOKENを実際のSquareアクセストークンに置き換えてください。Square Access Tokensのガイドに従うことでアクセストークンを入手できます。コマンドを実行する前に環境変数を設定することもできます。

リモートMCPサーバー

Squareは以下でホストされたリモートMCPサーバーを提供しています:

リモートサーバーは推奨されます。OAuthを使うので、アクセストークンの作成や管理をせずにSquareアカウントでサインインできます。

このページは AI により自動翻訳されています。技術的な詳細は原文をご確認ください。

README

以下は原文 README の抜粋です。原文を見る。

Square Model Context Protocol Server (Beta)

This project follows the Model Context Protocol standard, allowing AI assistants to interact with Square’s connect API.

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 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.

Quick Start

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.

# 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.

Remote MCP Server

Square offers a hosted remote MCP server at:

https://mcp.squareup.com/mcp

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. The older https://mcp.squareup.com/sse endpoint is still served for existing SSE configurations.

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:

Remote MCP

To install the Square remote MCP in Goose, click this URL on a computer where Goose is installed:

GitHub で README 全文を見る

インストール

npx mcp-remote https://mcp.squareup.com/mcp

MCP 初心者？mcpskill.org のガイドから始めましょう →

設定

{
  "mcpServers": {
    "mcp_square_api": {
      "command": "npx",
      "args": ["mcp-remote", "https://mcp.squareup.com/mcp"]
    }
  }
}