Square MCP Server

🚀 方形モデルコンテキストプロトコルサーバー（Beta版）

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

🚀 クイックスタート

npxを使用して、方形MCPサーバーを迅速に起動できます。

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

# 環境設定を使用する場合
ACCESS_TOKEN=YOUR_SQUARE_ACCESS_TOKEN SANDBOX=true npx square-mcp-server start

# 開発モードで起動
npm run dev

設定オプション

利用可能な環境変数とその用途は以下の通りです。

依存関係のインストール

プロジェクトに必要な依存関係をインストールするには、以下のコマンドを実行してください。

npm install

✨ 主な機能

方形MCPサーバーは以下の主要な機能を提供します。

1. サービス情報の発見：get_service_infoメソッドを使用して、利用可能なサービスを発見します。
2. タイプ情報の取得：get_type_infoメソッドを使用して、特定のサービスの詳細情報を取得します。
3. APIリクエストの実行：make_api_requestメソッドを利用して、実際のAPI操作を実行します。

💻 使用例

基本的な使用法

1. サービス情報の発見

get_service_info(service: "catalog")

2. タイプ情報の取得

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

3. APIリクエストの実行

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

📚 ドキュメント

MCPインスペクターの使用

開発とデバッグを支援するために、MCPインスペクターを使用できます。

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

# インスペクターを起動
npx @modelcontextprotocol/inspector node dist/index.js start

開発フロー

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

🔧 技術詳細

このリポジトリはSquareのOpenAPI仕様に基づいて自動生成されています。貢献は歓迎されますが、すべての変更はコード生成器に統合する必要があります。プルリクエストを送信する前に、提案された変更について問題を開いて議論してください。

何か質問や追加の支援が必要な場合は、いつでもプロジェクトのメンテナに連絡してください。