Square MCP

🚀 方形模型上下文協議服務器 (Beta)

本項目遵循 模型上下文協議 標準，允許人工智能助手與Square的連接API進行交互。

🚀 快速開始

使用npx啟動並運行Square 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訪問令牌。你可以按照 Square訪問令牌 中的指南獲取訪問令牌。你也可以在運行命令之前設置環境變量。

🌐 遠程MCP服務器

Square現在在以下地址提供託管的遠程MCP服務器：

https://mcp.squareup.com/sse

建議使用遠程MCP，因為它使用OAuth認證，允許你直接使用Square賬戶登錄，而無需手動創建或管理訪問令牌。

⚙️ 配置選項

🤖 與人工智能助手集成

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複製並粘貼到你的瀏覽器地址欄中。

# 自動安裝
npx square-mcp-server install

# 獲取手動安裝的URL
npx square-mcp-server get-goose-url

install 命令會自動更新你的Goose配置。

Claude桌面集成

對於Claude桌面集成，請參閱 模型上下文協議快速入門指南。將以下配置添加到你的 claude_desktop_config.json 中：

• 遠程MCP：

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

這種方法允許你直接使用Square賬戶憑證進行認證，而無需管理訪問令牌。

• 本地MCP：

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

🛠️ 工具參考

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檢查器 提供了一個可視化界面用於測試：

# 構建項目
npm run build

# 使用Square 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檢查器測試你的更改

🤝 貢獻

此倉庫是從Square的OpenAPI規範自動生成的。雖然歡迎貢獻，但請注意，更改需要合併到生成此代碼的生成器中。請在提交拉取請求之前打開一個問題來討論提議的更改。