डेवलपर दस्तावेज़
SosoAPI इंस्टॉल करें: पैकेज, क्लाइंट और रिमोट MCP
लोकल पैकेज या होस्ट किए MCP से अपना एजेंट SosoAPI से जोड़ें। इस गाइड में इंस्टॉलेशन, कनेक्शन जाँच और अपडेट शामिल हैं।
Markdown में पढ़ेंSosoAPI टीम द्वारा समीक्षा ·
मुझे कौन-सा npm पैकेज इंस्टॉल करना चाहिए?
नए सेटअप के लिए sosoapi इंस्टॉल करें। @sosoapi/cli, sosoapi-cli और sosoapi-mcp उपनाम हैं जो sosoapi का ठीक वही संस्करण इंस्टॉल करते हैं। वे समान CLI और MCP टूल चलाते हैं, इसलिए एक पैकेज ही चाहिए।
लोकल MCP के लिए Node.js 20 या बाद का संस्करण और npm/npx चाहिए। होस्ट किए MCP में लोकल पैकेज नहीं चाहिए। इंस्टॉल या कनेक्ट करने के बाद खातों का एक्सेस देने के लिए साइन इन करें।
| पैकेज | उद्देश्य | कमांड |
|---|---|---|
| sosoapi | कैनोनिकल CLI और MCP सर्वर | npx -y sosoapi --help |
| @sosoapi/cli | sosoapi के ठीक उसी संस्करण का उपनाम | npx -y @sosoapi/cli --help |
| sosoapi-cli | sosoapi के ठीक उसी संस्करण का उपनाम | npx -y sosoapi-cli --help |
| sosoapi-mcp | sosoapi के ठीक उसी संस्करण का उपनाम | npx -y sosoapi-mcp --help |
लोकल MCP क्लाइंट कनेक्ट करें
core-profile कनेक्शन जोड़ने के लिए नीचे की कमांड इस्तेमाल करें। SosoAPI पहले से जुड़ा और काम करता हो, तो वही कनेक्शन रखें। बिना arguments sosoapi चलाने से stdio MCP सर्वर शुरू होता है; वह stdin पर क्लाइंट की प्रतीक्षा करता है।
Claude Desktop, Cursor या दूसरे stdio क्लाइंट की MCP सेटिंग में नीचे का JSON जोड़ें। सेटिंग की जगह और अनुमति चरण क्लाइंट के अनुसार बदलते हैं। ज़रूरत हो तो रीस्टार्ट या फिर कनेक्ट करें, फिर बातचीत में SosoAPI टूल उपलब्ध होने की जाँच करें।
claude mcp add sosoapi -e SOSOAPI_TOOL_PROFILE=core -- npx -y sosoapicodex mcp add sosoapi --env SOSOAPI_TOOL_PROFILE=core -- npx -y sosoapi{
"mcpServers": {
"sosoapi": {
"command": "npx",
"args": [
"-y",
"sosoapi"
],
"env": {
"SOSOAPI_TOOL_PROFILE": "core"
}
}
}
}OAuth से रिमोट MCP कनेक्ट करें
रिमोट MCP, OAuth और डायनेमिक क्लाइंट पंजीकरण सपोर्ट करने वाले क्लाइंट में नीचे का URL जोड़ें। ब्राउज़र से साइन इन करके अनुमत वर्कस्पेस और कार्रवाइयाँ चुनें। API key, client ID या client secret पेस्ट करने की ज़रूरत नहीं है। HTTP से मीडिया देने के लिए सार्वजनिक URL इम्पोर्ट करें; लोकल फ़ाइल अपलोड के लिए लोकल MCP सर्वर चाहिए।
ChatGPT कस्टम ऐप और Claude रिमोट कनेक्टर प्लान तथा क्लाइंट की उपलब्ध कनेक्टर सेटिंग पर निर्भर हैं। ये निर्देश कस्टम कनेक्शन सेट करते हैं; ऐप डायरेक्टरी लिस्टिंग का विवरण नहीं देते।
https://gqeshlawtcexsapabaui.supabase.co/functions/v1/remote-mcpप्रकाशित किए बिना सेटअप सत्यापित करें
प्रमाणीकरण स्थिति जाँचें और ज़रूरत हो तो साइन इन करें। वर्कस्पेस संदर्भ और जुड़े खाते पढ़ें, फिर पुष्टि करें कि लौटाए खाते व वर्कस्पेस वही हैं जिन्हें आप चाहते थे। इससे पोस्ट सबमिट किए बिना एक्सेस सत्यापित होता है; प्रकाशन अभी भी खाते की अनुमतियों पर निर्भर है।
सेटअप पूरा करने के लिए टेस्ट पोस्ट प्रकाशित करना ज़रूरी नहीं है। मौजूदा कंटेंट के साथ मूल काम जारी रखें। किसी भी अनुरोधित राइट से पहले यूज़र प्रोवाइडर सहमति पूरी करता है और गंतव्य, कंटेंट व समय की समीक्षा करता है।
npx sosoapi auth statusnpx sosoapi api contract --route /identity-api/workspace/list --summaryसंस्करण अपडेट करें या पिन करें
मौजूदा CLI पाने के लिए npx -y sosoapi@latest --help चलाएँ, फिर MCP क्लाइंट रीस्टार्ट करें। क्लाइंट में कमांड सहेजी हो, तो उसके args में इच्छित संस्करण रखें। उपनाम अपने निश्चित sosoapi संस्करण से जुड़े रहते हैं; अलग ग्लोबल इंस्टॉलेशन अपडेट करने से वे अपडेट नहीं होंगे।
संस्करण में अंतर की त्रुटि दिखे, तो इंस्टॉल कॉन्ट्रैक्ट की आवश्यक ऑपरेशन से तुलना करें। MCP क्लाइंट की वास्तविक कमांड वाला पैकेज अपडेट करें, फिर कनेक्ट करें और वही ऑपरेशन आज़माएँ। स्कीमा के मेल न खाने पर नए क्रेडेंशियल या व्यापक एक्सेस की ज़रूरत नहीं है।
npx -y sosoapi@latest --helpnpx sosoapi api contract --summary