Square

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

Square Model Context Protocol सर्वर (बीटा)

यह प्रोजेक्ट Model Context Protocol मानक का पालन करता है, जो AI सहायकों को Square के connect API के साथ इंटरैक्ट करने की अनुमति देता है।

अधिकांश लोगों को होस्टेड सर्वर का उपयोग करना चाहिए। Square https://mcp.squareup.com/mcp पर OAuth साइन-इन के साथ एक रिमोट MCP सर्वर चलाता है; अपने AI सहायक के साथ सेटअप के लिए Square MCP दस्तावेज़ देखें। यह रिपॉजिटरी स्थानीय, स्व-होस्टेड सर्वर है: यदि आप अपनी स्वयं की प्रति चलाना चाहते हैं तो यह एक प्रारंभिक बिंदु है। कोड परिवर्तन Contributing के अंतर्गत वर्णित जनरेटर के माध्यम से होते हैं।

त्वरित प्रारंभ

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

YOUR_SQUARE_ACCESS_TOKEN को अपने वास्तविक Square एक्सेस टोकन से बदलें। आप Square Access Tokens गाइड का पालन करके अपना एक्सेस टोकन प्राप्त कर सकते हैं। आप कमांड चलाने से पहले पर्यावरण चर भी सेट कर सकते हैं।

रिमोट MCP सर्वर

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

https://mcp.squareup.com/mcp

रिमोट सर्वर अनुशंसित है: यह OAuth का उपयोग करता है, इसलिए आप एक्सेस टोकन बनाने और प्रबंधित करने के बजाय अपने Square खाते से साइन इन करते हैं। Claude, ChatGPT, Goose और अन्य सहायकों के लिए सेटअप गाइड Square MCP दस्तावेज़ में हैं। पुराना https://mcp.squareup.com/sse एंडपॉइंट मौजूदा SSE कॉन्फ़िगरेशन के लिए अभी भी सेवा प्रदान करता है।

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

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

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

Goose एकीकरण

Goose के साथ Square MCP सर्वर को कॉन्फ़िगर करने के लिए:

रिमोट MCP

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

स्थानीय MCP

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

टूल संदर्भ

Square MCP सर्वर Square APIs के साथ इंटरैक्ट करने के लिए उपकरणों का एक सुव्यवस्थित सेट प्रदान करता है:

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

सेवा सूची

Square MCP सर्वर Square के पूर्ण API पारिस्थितिकी तंत्र तक पहुँच प्रदान करता है। प्रत्येक सेवा के बारे में विस्तृत जानकारी के लिए 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	इवेंट सूचनाएँ

उपयोग पैटर्न

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 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. निर्भरताएँ स्थापित करें: npm install
3. विकास मोड प्रारंभ करें: npm run watch
4. सर्वर चलाएँ: node dist/index.js start
5. MCP Inspector का उपयोग करके अपने परिवर्तनों का परीक्षण करें

योगदान

यह रिपॉजिटरी Square के OpenAPI Specification से स्वचालित रूप से उत्पन्न होती है। योगदान का स्वागत है, हालाँकि कृपया ध्यान दें कि परिवर्तनों को उस जनरेटर में शामिल करने की आवश्यकता होगी जो यह कोड उत्पन्न करता है। पुल अनुरोध सबमिट करने से पहले प्रस्तावित परिवर्तनों पर चर्चा करने के लिए कृपया एक मुद्दा खोलें।