Square MCP Server

公式

Square用のModel Context Protocol (MCP)サーバー

GitHub

100

ドキュメント

Square Model Context Protocol Server (ベータ版)

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

Square Model Context Protocol Server MCP server

クイックスタート

npxを使用してSquare MCPサーバーを起動します。

# 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

YOUR_SQUARE_ACCESS_TOKEN を実際のSquareアクセストークンに置き換えてください。アクセストークンはSquareアクセストークンのガイドに従って取得できます。また、コマンドを実行する前に環境変数を設定することも可能です。

リモートMCPサーバー

Squareは現在、以下の場所でホスト型リモートMCPサーバーを提供しています。

https://mcp.squareup.com/sse

リモートMCPはOAuth認証を使用するため、アクセストークンを手動で作成・管理することなく、Squareアカウントで直接ログインできるため推奨されます。

設定オプション

環境変数	目的	例
`ACCESS_TOKEN`	Square APIアクセストークン	`ACCESS_TOKEN=sq0atp-...`
`SANDBOX`	Squareサンドボックス環境を使用	`SANDBOX=true`
`PRODUCTION`	Square本番環境を使用	`PRODUCTION=true`
`DISALLOW_WRITES`	読み取り専用操作に制限	`DISALLOW_WRITES=true`
`SQUARE_VERSION`	Square APIバージョンを指定	`SQUARE_VERSION=2025-04-16`

AIアシスタントとの統合

Goose統合

GooseでSquare MCPサーバーを設定するには：

リモートMCP

Gooseがインストールされているコンピューターで、以下のURLをクリックしてSquareリモートMCPをインストールします。

goose://extension?cmd=npx&arg=mcp-remote&arg=https%3A%2F%2Fmcp.squareup.com%2Fsse&id=square_mcp_production_remote&name=Square%20MCP%20Remote&description=Square%20Production%20MCP%20Remote

または、URLをブラウザのアドレスバーにコピー＆ペーストしてください。

# Automatic installation
npx square-mcp-server install

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

install コマンドにより、Gooseの設定が自動的に更新されます。

Claude Desktop統合

Claude Desktopとの統合については、Model Context Protocolクイックスタートガイドを参照してください。claude_desktop_config.json に以下の設定を追加します。

リモートMCP

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

このアプローチでは、アクセストークンを管理することなく、Squareアカウントの認証情報で直接認証できます。

ローカルMCP

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

ツールリファレンス

Square MCPサーバーは、Square APIと対話するための合理化されたツールセットを提供します。

ツール	説明	主な用途
`get_service_info`	サービスで利用可能なメソッドを検出	探索と検出
`get_type_info`	詳細なパラメーター要件を取得	リクエスト準備
`make_api_request`	SquareへのAPI呼び出しを実行	操作の実行

サービスカタログ

Square MCPサーバーは、Squareの完全なAPIエコシステムへのアクセスを提供します。各サービスの詳細については、Square APIドキュメントを参照してください。

サービス	説明
`applepay`	Apple Pay統合
`bankaccounts`	銀行口座管理
`bookingcustomattributes`	予約のカスタム属性
`bookings`	予約管理
`cards`	支払いカード管理
`cashdrawers`	キャッシュドロワー管理
`catalog`	カタログ管理（商品、カテゴリなど）
`checkout`	チェックアウトと支払い処理
`customercustomattributes`	顧客のカスタム属性
`customergroups`	顧客グループ化
`customersegments`	顧客セグメンテーション
`customers`	顧客管理
`devices`	Squareデバイス管理
`disputes`	支払い紛争処理
`events`	イベント追跡
`giftcardactivities`	ギフトカードアクティビティ追跡
`giftcards`	ギフトカード管理
`inventory`	在庫追跡
`invoices`	請求書管理
`labor`	労務管理
`locationcustomattributes`	ロケーションのカスタム属性
`locations`	ロケーション管理
`loyalty`	ロイヤルティプログラム管理
`merchantcustomattributes`	マーチャントのカスタム属性
`merchants`	マーチャントアカウント管理
`oauth`	認証
`ordercustomattributes`	注文のカスタム属性
`orders`	注文管理
`payments`	支払い処理
`payouts`	支払い管理
`refunds`	返金管理
`sites`	Webサイト統合
`snippets`	Square Online Code統合
`subscriptions`	サブスクリプション管理
`team`	スタッフ管理
`terminal`	Square Terminal管理
`vendors`	サプライヤー管理
`webhooksubscriptions`	イベント通知

使用パターン

MCPを通じてSquare APIと最適に対話するには：

検出: get_service_info を使用して利用可能なメソッドを探索します
```
get_service_info(service: "catalog")
```
理解: get_type_info を使用してパラメーター要件を学習します
```
get_type_info(service: "catalog", method: "list")
```

実行: make_api_request を使用して操作を実行します

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

開発とデバッグ

MCP Inspectorの使用

MCP Inspectorはテスト用のビジュアルインターフェースを提供します。

# Build the project
npm run build

# Start the inspector with the Square MCP Server
npx @modelcontextprotocol/inspector node dist/index.js start

開発ワークフロー

リポジトリをクローンします
依存関係をインストールします: npm install
開発モードを開始します: npm run watch
サーバーを実行します: node dist/index.js start
MCP Inspectorを使用して変更をテストします

貢献

このリポジトリはSquareのOpenAPI仕様から自動生成されています。貢献は歓迎しますが、変更はこのコードを生成するジェネレーターに組み込む必要があることに注意してください。プルリクエストを送信する前に、提案された変更について話し合うためにIssueを作成してください。