スクエアモデルコンテキストプロトコルサーバー

スクエアモデルコンテキストプロトコルサーバー（ベータ版）

このプロジェクトはモデルコンテキストプロトコル標準に準拠しており、AI アシスタントが Square の connect API と対話できるようになります。

クイックスタート

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アクセストークンのガイドに従って取得できます。コマンド実行前に環境変数を設定することもできます。

設定オプション

環境変数	目的	例
`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 サーバーを構成するには:

# Automatic installation
npx square-mcp-server install

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

installコマンドは Goose の設定を自動的に更新します。

クロードデスクトップ統合

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

{
  "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`	ウェブサイトの統合
`snippets`	Squareオンラインコードの統合
`subscriptions`	サブスクリプション管理
`team`	スタッフ管理
`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インスペクターの使用

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を開いて変更案について議論してください。

Square Model Context Protocol Server

Integrations