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

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

クイックスタート

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

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

リモートMCPサーバー

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

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

設定オプション

AIアシスタントとの統合

Goose統合

Gooseを使用して Square MCP サーバーを構成するには:

リモートMCP

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

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 をコピーしてブラウザのアドレスバーに貼り付けます。

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

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

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

リモートMCP

この方法により、アクセス トークンを管理する必要なく、Square アカウントの資格情報を使用して直接認証できます。

ローカルMCP

ツールリファレンス

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

サービスカタログ

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

使用パターン

MCP を介して Square API と最適にやりとりするには:

1. 発見: get_service_infoを使用して利用可能なメソッドを調べる

   get_service_info(service: "catalog")

2. 理解: get_type_infoを使用してパラメータの要件を確認する

   get_type_info(service: "catalog", method: "list")

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

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

開発とデバッグ

MCPインスペクターの使用

MCP Inspector は、テスト用の視覚的なインターフェースを提供します。

開発ワークフロー

1. リポジトリをクローンする

2. 依存関係をインストール: npm install

3. 開発モードを開始: npm run watch

4. サーバーを実行します: node dist/index.js start

5. MCP Inspector を使用して変更をテストします

貢献

このリポジトリは、SquareのOpenAPI仕様に基づいて自動生成されています。貢献は歓迎しますが、変更内容はこのコードを生成するジェネレーターに反映される必要があることにご注意ください。プルリクエストを送信する前に、Issueを開いて変更案について議論してください。