スクエアモデルコンテキストプロトコルサーバー(ベータ版)
このプロジェクトはモデルコンテキストプロトコル標準に準拠しており、AI アシスタントが Square の connect API と対話できるようにします。
クイックスタート
npx を使用して Square MCP サーバーを起動して実行します。
YOUR_SQUARE_ACCESS_TOKENを実際のSquareアクセストークンに置き換えてください。アクセストークンは、 Squareアクセストークンのガイドに従って取得できます。コマンド実行前に環境変数を設定することもできます。
Related MCP server: Linear MCP Server
リモートMCPサーバー
Square は現在、次の場所でホスト型リモート MCP サーバーを提供しています。
リモート MCP は OAuth 認証を使用するため、アクセス トークンを手動で作成または管理することなく、Square アカウントで直接ログインできるため、推奨されます。
設定オプション
環境変数 | 目的 | 例 |
| Square APIアクセストークン |
|
| Squareサンドボックス環境を使用する |
|
| Square の制作環境を使用する |
|
| 読み取り専用操作に制限する |
|
| Square APIのバージョンを指定する |
|
AIアシスタントとの統合
Goose統合
Gooseを使用して Square MCP サーバーを構成するには:
リモートMCP
Goose に Square リモート MCP をインストールするには、Goose がインストールされているコンピューターで次の URL をクリックします。
または、URL をコピーしてブラウザのアドレスバーに貼り付けます。
installコマンドは、Goose の設定を自動的に更新します。
クロードデスクトップ統合
Claude Desktopとの統合については、 Model Context Protocolクイックスタートガイドclaude_desktop_config.jsonご覧ください。claude_desktop_config.jsonに以下の設定を追加してください。
リモートMCP
この方法により、アクセス トークンを管理する必要なく、Square アカウントの資格情報を使用して直接認証できます。
ローカルMCP
ツールリファレンス
Square MCP サーバーは、Square API と対話するための合理化されたツール セットを提供します。
道具 | 説明 | 主な用途 |
| サービスで利用可能なメソッドを見つける | 探検と発見 |
| 詳細なパラメータ要件を取得する | リクエストの準備 |
| SquareへのAPI呼び出しを実行する | 操作の実行 |
サービスカタログ
Square MCPサーバーは、Squareの完全なAPIエコシステムへのアクセスを提供します。各サービスの詳細については、 Square APIドキュメントをご覧ください。
サービス | 説明 |
| Apple Payの統合 |
| 銀行口座管理 |
| 予約のカスタム属性 |
| 予約管理 |
| 決済カード管理 |
| キャッシュドロワー管理 |
| カタログ管理(商品、カテゴリなど) |
| チェックアウトと支払い処理 |
| 顧客向けカスタム属性 |
| 顧客グループ分け |
| 顧客セグメンテーション |
| 顧客管理 |
| Squareデバイス管理 |
| 支払い紛争処理 |
| イベントトラッキング |
| ギフトカードアクティビティの追跡 |
| ギフトカード管理 |
| 在庫追跡 |
| 請求書管理 |
| 人材管理 |
| 場所のカスタム属性 |
| ロケーション管理 |
| ロイヤルティプログラム管理 |
| 販売者向けカスタム属性 |
| 加盟店アカウント管理 |
| 認証 |
| 注文のカスタム属性 |
| 注文管理 |
| 支払い処理 |
| 支払い管理 |
| 払い戻し管理 |
| ウェブサイトの統合 |
| Squareオンラインコードの統合 |
| サブスクリプション管理 |
| スタッフ管理 |
| スクエアターミナル管理 |
| サプライヤー管理 |
| イベント通知 |
使用パターン
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 は、テスト用の視覚的なインターフェースを提供します。
開発ワークフロー
リポジトリをクローンする
依存関係をインストール:
npm install開発モードを開始:
npm run watchサーバーを実行します:
node dist/index.js startMCP Inspector を使用して変更をテストします
貢献
このリポジトリは、SquareのOpenAPI仕様に基づいて自動生成されています。貢献は歓迎しますが、変更内容はこのコードを生成するジェネレーターに反映される必要があることにご注意ください。プルリクエストを送信する前に、Issueを開いて変更案について議論してください。