Square MCP Server

resmi

Server Model Context Protocol (MCP) untuk square

Dokumentasi

Server Protokol Konteks Model Square (Beta)

Proyek ini mengikuti standar Protokol Konteks Model, yang memungkinkan asisten AI berinteraksi dengan API koneksi Square.

Square Model Context Protocol Server MCP server

Mulai Cepat

Jalankan server Square MCP dengan cepat menggunakan npx:

# 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

Ganti YOUR_SQUARE_ACCESS_TOKEN dengan token akses Square Anda yang sebenarnya. Anda dapat memperoleh token akses dengan mengikuti panduan di Token Akses Square. Anda juga dapat mengatur variabel lingkungan sebelum menjalankan perintah.

Server MCP Jarak Jauh

Square kini menawarkan server MCP jarak jauh yang dihosting di:

https://mcp.squareup.com/sse

MCP jarak jauh direkomendasikan karena menggunakan autentikasi OAuth, memungkinkan Anda masuk dengan akun Square secara langsung tanpa harus membuat atau mengelola token akses secara manual.

Opsi Konfigurasi

Variabel Lingkungan	Tujuan	Contoh
`ACCESS_TOKEN`	Token akses API Square Anda	`ACCESS_TOKEN=sq0atp-...`
`SANDBOX`	Gunakan lingkungan sandbox Square	`SANDBOX=true`
`PRODUCTION`	Gunakan lingkungan produksi Square	`PRODUCTION=true`
`DISALLOW_WRITES`	Batasi hanya operasi baca	`DISALLOW_WRITES=true`
`SQUARE_VERSION`	Tentukan versi API Square	`SQUARE_VERSION=2025-04-16`

Integrasi dengan Asisten AI

Integrasi Goose

Untuk mengonfigurasi Server Square MCP dengan Goose:

MCP Jarak Jauh

Untuk menginstal Square MCP jarak jauh di Goose, klik URL ini di komputer tempat Goose terinstal:

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

Atau salin dan tempel URL tersebut ke bilah alamat peramban Anda.

# Automatic installation
npx square-mcp-server install

# Get URL for manual installation
npx square-mcp-server get-goose-url

Perintah install secara otomatis memperbarui konfigurasi Goose Anda.

Integrasi Claude Desktop

Untuk integrasi Claude Desktop, lihat Panduan Memulai Cepat Protokol Konteks Model. Tambahkan konfigurasi ini ke claude_desktop_config.json Anda:

MCP Jarak Jauh

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

Pendekatan ini memungkinkan Anda mengautentikasi langsung dengan kredensial akun Square tanpa perlu mengelola token akses.

MCP Lokal

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

Referensi Alat

Server Square MCP menyediakan seperangkat alat yang efisien untuk berinteraksi dengan API Square:

Alat	Deskripsi	Penggunaan Utama
`get_service_info`	Temukan metode yang tersedia untuk suatu layanan	Eksplorasi dan penemuan
`get_type_info`	Dapatkan persyaratan parameter secara rinci	Persiapan permintaan
`make_api_request`	Jalankan panggilan API ke Square	Melakukan operasi

Katalog Layanan

Server Square MCP menyediakan akses ke ekosistem API Square yang lengkap. Lihat Dokumentasi API Square untuk informasi rinci tentang setiap layanan:

Layanan	Deskripsi
`applepay`	Integrasi Apple Pay
`bankaccounts`	Manajemen rekening bank
`bookingcustomattributes`	Atribut khusus untuk pemesanan
`bookings`	Manajemen pemesanan janji temu
`cards`	Manajemen kartu pembayaran
`cashdrawers`	Manajemen laci kas
`catalog`	Manajemen katalog (item, kategori, dll.)
`checkout`	Checkout dan pemrosesan pembayaran
`customercustomattributes`	Atribut khusus untuk pelanggan
`customergroups`	Pengelompokan pelanggan
`customersegments`	Segmentasi pelanggan
`customers`	Manajemen pelanggan
`devices`	Manajemen perangkat Square
`disputes`	Penanganan sengketa pembayaran
`events`	Pelacakan acara
`giftcardactivities`	Pelacakan aktivitas kartu hadiah
`giftcards`	Manajemen kartu hadiah
`inventory`	Pelacakan inventaris
`invoices`	Manajemen faktur
`labor`	Manajemen tenaga kerja
`locationcustomattributes`	Atribut khusus untuk lokasi
`locations`	Manajemen lokasi
`loyalty`	Manajemen program loyalitas
`merchantcustomattributes`	Atribut khusus untuk pedagang
`merchants`	Manajemen akun pedagang
`oauth`	Autentikasi
`ordercustomattributes`	Atribut khusus untuk pesanan
`orders`	Manajemen pesanan
`payments`	Pemrosesan pembayaran
`payouts`	Manajemen pembayaran keluar
`refunds`	Manajemen pengembalian dana
`sites`	Integrasi situs web
`snippets`	Integrasi Kode Square Online
`subscriptions`	Manajemen langganan
`team`	Manajemen staf
`terminal`	Manajemen Terminal Square
`vendors`	Manajemen pemasok
`webhooksubscriptions`	Notifikasi acara

Pola Penggunaan

Untuk interaksi optimal dengan API Square melalui MCP:

Temukan: Gunakan get_service_info untuk menjelajahi metode yang tersedia
```
get_service_info(service: "catalog")
```
Pahami: Gunakan get_type_info untuk mempelajari persyaratan parameter
```
get_type_info(service: "catalog", method: "list")
```

Jalankan: Gunakan make_api_request untuk melakukan operasi

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

Pengembangan dan Debugging

Menggunakan Inspektur MCP

Inspektur MCP menyediakan antarmuka visual untuk pengujian:

# Build the project
npm run build

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

Alur Kerja Pengembangan

Kloning repositori
Instal dependensi: npm install
Mulai mode pengembangan: npm run watch
Jalankan server: node dist/index.js start
Uji perubahan Anda menggunakan Inspektur MCP

Berkontribusi

Repositori ini dibuat secara otomatis dari Spesifikasi OpenAPI Square. Meskipun kontribusi diterima, harap dicatat bahwa perubahan perlu dimasukkan ke dalam generator yang menghasilkan kode ini. Silakan buka isu untuk mendiskusikan perubahan yang diusulkan sebelum mengirimkan pull request.