Square MCP

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

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

🚀 クイックスタート

npxを使用してスクエアMCPサーバーを起動しましょう。

# 基本的な起動
npx square-mcp-server start

# 環境設定付き
ACCESS_TOKEN=YOUR_SQUARE_ACCESS_TOKEN SANDBOX=true npx square-mcp-server start

# ローカル実行
npx /path/to/project/square-mcp-server

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

リモートMCPサーバー

スクエアは現在、以下の場所にホストされたリモートMCPサーバーを提供しています。

https://mcp.squareup.com/sse

リモートMCPはOAuth認証を使用しているため、スクエアアカウントで直接ログインでき、アクセストークンを手動で作成または管理する必要がないため、おすすめです。

設定オプション

AIアシスタントとの統合

Gooseとの統合

Goose でスクエアMCPサーバーを設定するには、以下の手順を実行します。

リモートMCP

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

# 自動インストール
npx square-mcp-server install

# 手動インストール用のURLを取得
npx square-mcp-server get-goose-url

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

Claude Desktopとの統合

Claude Desktopとの統合については、Model Context Protocol Quickstart Guide を参照してください。claude_desktop_config.json に以下の設定を追加します。

リモートMCP

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

この方法では、アクセストークンを管理する必要なく、スクエアアカウントの資格情報で直接認証できます。

ローカルMCP

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

ツールリファレンス

スクエアMCPサーバーは、スクエアAPIとやり取りするための一連の簡素化されたツールを提供します。

サービスカタログ

スクエアMCPサーバーは、スクエアの完全な APIエコシステム にアクセスできます。各サービスの詳細情報については、Square API Documentation を参照してください。

使用パターン

MCPを通じてスクエア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インスペクター は、テスト用の視覚的なインターフェースを提供します。

# プロジェクトをビルドする
npm run build

# スクエアMCPサーバーでインスペクターを起動する
npx @modelcontextprotocol/inspector node dist/index.js start

開発ワークフロー

1. リポジトリをクローンする
2. 依存関係をインストールする: npm install
3. 開発モードを開始する: npm run watch
4. サーバーを起動する: node dist/index.js start
5. MCPインスペクターを使用して変更をテストする

コントリビューション

このリポジトリは、スクエアのOpenAPI仕様から自動生成されています。コントリビューションは歓迎されますが、変更はこのコードを生成するジェネレーターに組み込む必要があります。プルリクエストを送信する前に、提案された変更について議論するために、issueを開いてください。