Square

npx add-mcp 'https://mcp.squareup.com/sse' --transport sse

Square Model Context Protocol Server (Beta)

โปรเจกต์นี้เป็นไปตามมาตรฐาน Model Context Protocol ซึ่งช่วยให้ผู้ช่วย AI สามารถโต้ตอบกับ Square connect API ได้

คนส่วนใหญ่ควรใช้เซิร์ฟเวอร์แบบโฮสต์ Square ให้บริการ MCP server ระยะไกลที่ https://mcp.squareup.com/mcp พร้อมการเข้าสู่ระบบด้วย OAuth; ดู เอกสาร Square MCP สำหรับการตั้งค่ากับผู้ช่วย AI ของคุณ ที่เก็บนี้เป็นเซิร์ฟเวอร์แบบโลคัลที่โฮสต์เอง: เป็นจุดเริ่มต้นหากคุณต้องการรันสำเนาของคุณเอง การเปลี่ยนแปลงโค้ดจะผ่านตัวสร้างที่อธิบายไว้ในหัวข้อ Contributing

เริ่มต้นอย่างรวดเร็ว

เริ่มต้นใช้งานเซิร์ฟเวอร์แบบโลคัลด้วย npx คำสั่งนี้จะรันเซิร์ฟเวอร์บนเครื่องของคุณเองด้วย access token ของคุณเอง; สำหรับเซิร์ฟเวอร์แบบโฮสต์ ดูหมายเหตุด้านบน

# Basic startup
npx square-mcp-server start

# With environment configuration
ACCESS_TOKEN=YOUR_SQUARE_ACCESS_TOKEN SANDBOX=true npx square-mcp-server start

# local runs
npx /path/to/project/square-mcp-server

แทนที่ YOUR_SQUARE_ACCESS_TOKEN ด้วย Square access token จริงของคุณ คุณสามารถรับ access token ได้โดยทำตามคำแนะนำที่ Square Access Tokens คุณยังสามารถตั้งค่าตัวแปรสภาพแวดล้อมก่อนรันคำสั่งได้

เซิร์ฟเวอร์ MCP ระยะไกล

Square ให้บริการ MCP server ระยะไกลแบบโฮสต์ที่:

https://mcp.squareup.com/mcp

เซิร์ฟเวอร์ระยะไกลเป็นตัวเลือกที่แนะนำ: ใช้ OAuth ดังนั้นคุณเข้าสู่ระบบด้วยบัญชี Square ของคุณแทนการสร้างและจัดการ access tokens คำแนะนำการตั้งค่าสำหรับ Claude, ChatGPT, Goose และผู้ช่วยอื่น ๆ อยู่ใน เอกสาร Square MCP ปลายทาง https://mcp.squareup.com/sse รุ่นเก่ายังคงให้บริการสำหรับการกำหนดค่า SSE ที่มีอยู่

ตัวเลือกการกำหนดค่า

ตัวแปรสภาพแวดล้อม	วัตถุประสงค์	ตัวอย่าง
ACCESS_TOKEN	Square API access token ของคุณ	ACCESS_TOKEN=sq0atp-...
SANDBOX	ใช้สภาพแวดล้อม sandbox ของ Square	SANDBOX=true
PRODUCTION	ใช้สภาพแวดล้อม production ของ Square	PRODUCTION=true
DISALLOW_WRITES	จำกัดเฉพาะการดำเนินการแบบอ่านอย่างเดียว	DISALLOW_WRITES=true
SQUARE_VERSION	ระบุเวอร์ชัน Square API	SQUARE_VERSION=2025-04-16

การผสานรวมกับผู้ช่วย AI

การผสานรวมกับ Goose

เพื่อกำหนดค่า Square MCP Server กับ Goose:

MCP ระยะไกล

เพื่อติดตั้ง Square MCP ระยะไกลใน Goose คลิกที่ URL นี้บนคอมพิวเตอร์ที่ติดตั้ง Goose:

goose://extension?cmd=npx&arg=mcp-remote&arg=https%3A%2F%2Fmcp.squareup.com%2Fmcp&id=square_mcp_production_remote&name=Square%20MCP%20Remote&description=Square%20Production%20MCP%20Remote

หรือคัดลอกและวาง URL ลงในแถบที่อยู่ของเบราว์เซอร์

คำสั่งด้านล่างกำหนดค่าเซิร์ฟเวอร์แบบโลคัล (npx square-mcp-server start) ไม่ใช่แบบโฮสต์:

# Automatic installation
npx square-mcp-server install

# Get URL for manual installation
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/mcp"]
    }
  }
}

วิธีนี้ช่วยให้คุณยืนยันตัวตนด้วยข้อมูลประจำตัวบัญชี Square ของคุณโดยตรงโดยไม่ต้องจัดการ access tokens

MCP แบบโลคัล

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

คู่มือเครื่องมือ

Square MCP Server มีชุดเครื่องมือที่ปรับปรุงแล้วสำหรับการโต้ตอบกับ Square APIs:

เครื่องมือ	คำอธิบาย	การใช้งานหลัก
get_service_info	ค้นพบวิธีการที่มีให้สำหรับบริการ	การสำรวจและการค้นพบ
get_type_info	รับข้อกำหนดพารามิเตอร์โดยละเอียด	การเตรียมคำขอ
make_api_request	ดำเนินการเรียก API ไปยัง Square	การดำเนินการต่าง ๆ

แคตตาล็อกบริการ

Square MCP Server ให้การเข้าถึง ระบบนิเวศ API ทั้งหมดของ Square ดู เอกสาร Square API สำหรับข้อมูลโดยละเอียดเกี่ยวกับแต่ละบริการ:

บริการ	คำอธิบาย
applepay	การผสานรวม Apple Pay
bankaccounts	การจัดการบัญชีธนาคาร
bookingcustomattributes	คุณลักษณะที่กำหนดเองสำหรับการจอง
bookings	การจัดการการจองนัดหมาย
cards	การจัดการบัตรชำระเงิน
cashdrawers	การจัดการลิ้นชักเงินสด
catalog	การจัดการแคตตาล็อก (รายการ, หมวดหมู่ ฯลฯ)
checkout	การชำระเงินและการประมวลผลการชำระเงิน
customercustomattributes	คุณลักษณะที่กำหนดเองสำหรับลูกค้า
customergroups	การจัดกลุ่มลูกค้า
customersegments	การแบ่งกลุ่มลูกค้า
customers	การจัดการลูกค้า
devices	การจัดการอุปกรณ์ Square
disputes	การจัดการข้อพิพาทการชำระเงิน
events	การติดตามเหตุการณ์
giftcardactivities	การติดตามกิจกรรมบัตรของขวัญ
giftcards	การจัดการบัตรของขวัญ
inventory	การติดตามสินค้าคงคลัง
invoices	การจัดการใบแจ้งหนี้
labor	การจัดการแรงงาน
locationcustomattributes	คุณลักษณะที่กำหนดเองสำหรับสถานที่
locations	การจัดการสถานที่
loyalty	การจัดการโปรแกรมความภักดี
merchantcustomattributes	คุณลักษณะที่กำหนดเองสำหรับผู้ค้า
merchants	การจัดการบัญชีผู้ค้า
oauth	การยืนยันตัวตน
ordercustomattributes	คุณลักษณะที่กำหนดเองสำหรับคำสั่งซื้อ
orders	การจัดการคำสั่งซื้อ
payments	การประมวลผลการชำระเงิน
payouts	การจัดการการจ่ายเงิน
refunds	การจัดการการคืนเงิน
sites	การผสานรวมเว็บไซต์
snippets	การผสานรวม Square Online Code
subscriptions	การจัดการการสมัครสมาชิก
team	การจัดการพนักงาน
terminal	การจัดการ Square Terminal
vendors	การจัดการซัพพลายเออร์
webhooksubscriptions	การแจ้งเตือนเหตุการณ์

รูปแบบการใช้งาน

สำหรับการโต้ตอบที่เหมาะสมที่สุดกับ Square API ผ่าน MCP:

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 Inspector

MCP Inspector ให้อินเทอร์เฟซภาพสำหรับการทดสอบ:

# Build the project
npm run build

# Start the inspector with the Square MCP Server
npx @modelcontextprotocol/inspector node dist/index.js start

ขั้นตอนการพัฒนา

1. โคลนที่เก็บ
2. ติดตั้ง dependencies: npm install
3. เริ่มโหมดพัฒนา: npm run watch
4. รันเซิร์ฟเวอร์: node dist/index.js start
5. ทดสอบการเปลี่ยนแปลงของคุณโดยใช้ MCP Inspector

การมีส่วนร่วม

ที่เก็บนี้ถูกสร้างโดยอัตโนมัติจาก OpenAPI Specification ของ Square แม้ว่ายินดีรับการมีส่วนร่วม แต่โปรดทราบว่าการเปลี่ยนแปลงจะต้องถูกรวมเข้าในตัวสร้างที่ผลิตโค้ดนี้ โปรดเปิด issue เพื่อหารือเกี่ยวกับการเปลี่ยนแปลงที่เสนอก่อนส่ง pull request