Square MCP Server

स्क्वायर मॉडल कॉन्टेक्स्ट प्रोटोकॉल सर्वर (बीटा)

यह प्रोजेक्ट मॉडल कॉन्टेक्स्ट प्रोटोकॉल मानक का पालन करता है, जो AI सहायकों को स्क्वायर के कनेक्ट API के साथ इंटरैक्ट करने की अनुमति देता है।

त्वरित शुरुआत

npx का उपयोग करके स्क्वायर MCP सर्वर के साथ शुरुआत करें:

# 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 को अपने वास्तविक स्क्वायर एक्सेस टोकन से बदलें। आप स्क्वायर एक्सेस टोकन पर गाइड का पालन करके अपना एक्सेस टोकन प्राप्त कर सकते हैं। आप कमांड चलाने से पहले एनवायरनमेंट वेरिएबल भी सेट कर सकते हैं।

रिमोट MCP सर्वर

स्क्वायर अब एक होस्टेड रिमोट MCP सर्वर प्रदान करता है:

https://mcp.squareup.com/sse

रिमोट MCP की अनुशंसा की जाती है क्योंकि यह OAuth प्रमाणीकरण का उपयोग करता है, जिससे आप मैन्युअल रूप से एक्सेस टोकन बनाए या प्रबंधित किए बिना सीधे अपने स्क्वायर खाते से लॉग इन कर सकते हैं।

कॉन्फ़िगरेशन विकल्प

एनवायरनमेंट वेरिएबल	उद्देश्य	उदाहरण
ACCESS_TOKEN	आपका स्क्वायर API एक्सेस टोकन	ACCESS_TOKEN=sq0atp-...
SANDBOX	स्क्वायर सैंडबॉक्स वातावरण का उपयोग करें	SANDBOX=true
PRODUCTION	स्क्वायर प्रोडक्शन वातावरण का उपयोग करें	PRODUCTION=true
DISALLOW_WRITES	केवल-पढ़ने के संचालन तक सीमित रखें	DISALLOW_WRITES=true
SQUARE_VERSION	स्क्वायर API संस्करण निर्दिष्ट करें	SQUARE_VERSION=2025-04-16

AI सहायकों के साथ एकीकरण

गूज़ एकीकरण

गूज़ के साथ स्क्वायर MCP सर्वर को कॉन्फ़िगर करने के लिए:

रिमोट MCP

गूज़ में स्क्वायर रिमोट MCP स्थापित करने के लिए, उस कंप्यूटर पर इस 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 को अपने ब्राउज़र के एड्रेस बार में कॉपी और पेस्ट करें।

# Automatic installation
npx square-mcp-server install

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

install कमांड स्वचालित रूप से आपके गूज़ कॉन्फ़िगरेशन को अपडेट करता है।

क्लॉड डेस्कटॉप एकीकरण

क्लॉड डेस्कटॉप एकीकरण के लिए, मॉडल कॉन्टेक्स्ट प्रोटोकॉल क्विकस्टार्ट गाइड देखें। इस कॉन्फ़िगरेशन को अपने 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 के साथ इंटरैक्ट करने के लिए एक सुव्यवस्थित टूल सेट प्रदान करता है:

टूल	विवरण	प्राथमिक उपयोग
get_service_info	किसी सेवा के लिए उपलब्ध विधियों की खोज करें	अन्वेषण और खोज
get_type_info	विस्तृत पैरामीटर आवश्यकताएँ प्राप्त करें	अनुरोध तैयारी
make_api_request	स्क्वायर पर API कॉल निष्पादित करें	संचालन करना

सेवा सूची

स्क्वायर MCP सर्वर स्क्वायर के संपूर्ण API इकोसिस्टम तक पहुँच प्रदान करता है। प्रत्येक सेवा के बारे में विस्तृत जानकारी के लिए स्क्वायर API दस्तावेज़ीकरण देखें:

सेवा	विवरण
applepay	Apple Pay एकीकरण
bankaccounts	बैंक खाता प्रबंधन
bookingcustomattributes	बुकिंग के लिए कस्टम विशेषताएँ
bookings	अपॉइंटमेंट बुकिंग प्रबंधन
cards	भुगतान कार्ड प्रबंधन
cashdrawers	कैश ड्रॉअर प्रबंधन
catalog	कैटलॉग प्रबंधन (आइटम, श्रेणियाँ, आदि)
checkout	चेकआउट और भुगतान प्रसंस्करण
customercustomattributes	ग्राहकों के लिए कस्टम विशेषताएँ
customergroups	ग्राहक समूहीकरण
customersegments	ग्राहक विभाजन
customers	ग्राहक प्रबंधन
devices	स्क्वायर डिवाइस प्रबंधन
disputes	भुगतान विवाद प्रबंधन
events	घटना ट्रैकिंग
giftcardactivities	गिफ्ट कार्ड गतिविधि ट्रैकिंग
giftcards	गिफ्ट कार्ड प्रबंधन
inventory	इन्वेंट्री ट्रैकिंग
invoices	चालान प्रबंधन
labor	कार्यबल प्रबंधन
locationcustomattributes	स्थानों के लिए कस्टम विशेषताएँ
locations	स्थान प्रबंधन
loyalty	लॉयल्टी प्रोग्राम प्रबंधन
merchantcustomattributes	व्यापारियों के लिए कस्टम विशेषताएँ
merchants	व्यापारी खाता प्रबंधन
oauth	प्रमाणीकरण
ordercustomattributes	ऑर्डर के लिए कस्टम विशेषताएँ
orders	ऑर्डर प्रबंधन
payments	भुगतान प्रसंस्करण
payouts	भुगतान प्रबंधन
refunds	धनवापसी प्रबंधन
sites	वेबसाइट एकीकरण
snippets	स्क्वायर ऑनलाइन कोड एकीकरण
subscriptions	सदस्यता प्रबंधन
team	स्टाफ प्रबंधन
terminal	स्क्वायर टर्मिनल प्रबंधन
vendors	आपूर्तिकर्ता प्रबंधन
webhooksubscriptions	घटना सूचनाएँ

उपयोग पैटर्न

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 इंस्पेक्टर परीक्षण के लिए एक दृश्य इंटरफ़ेस प्रदान करता है:

# Build the project
npm run build

# Start the inspector with the Square MCP Server
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 विनिर्देश से स्वतः-उत्पन्न होती है। योगदान का स्वागत है, लेकिन कृपया ध्यान दें कि परिवर्तनों को उस जनरेटर में शामिल करने की आवश्यकता होगी जो यह कोड उत्पन्न करता है। कृपया पुल अनुरोध सबमिट करने से पहले प्रस्तावित परिवर्तनों पर चर्चा करने के लिए एक मुद्दा खोलें।