MCP सर्वर
Deckbase MCP
Deckbase के लिए Model Context Protocol सर्वर। AI टूल्स (Cursor, Claude Code, VS Code आदि) डॉक्स पढ़ सकते हैं और डेक व कार्ड्स मैनेज कर सकते हैं।
एंडपॉइंट
| मोड | एंडपॉइंट | ऑथ |
|---|---|---|
| होस्टेड (HTTP) | POST /api/mcp | Authorization: Bearer: डैशबोर्ड API key या OAuth access token। प्रोडक्शन में भी वही पाथ: /api/mcp। |
OAuth (ब्राउज़र लॉगिन) कनेक्ट करने का सबसे तेज़ तरीका है: Deckbase MCP से कनेक्ट करना देखें। स्क्रिप्ट और CI के लिए डैशबोर्ड API keys भी उपलब्ध हैं। MCP Basic, Pro और VIP सब्सक्राइबर्स के लिए उपलब्ध है। पूरा संदर्भ docs/public/MCP.md में read_doc के ज़रिए।
टूल्स
| टूल | विवरण | पैरामीटर |
|---|---|---|
| list_docs | docs/public/ में Markdown फ़ाइलें सूचीबद्ध करें। | कोई नहीं। |
| read_doc | पाथ से डॉक पढ़ें। केवल docs/public/ में मौजूद डॉक्स ही मिलते हैं। | path: उदा. MCP.md या deckbase://docs/public/MCP.md। |
| list_template_block_types | ब्लॉक टाइप keys और संख्यात्मक ids (text, media, interactive, layout)। create_template से पहले उपयोग करें। स्टैटिक डेटा। | कोई नहीं। |
| list_block_schemas | प्रति ब्लॉक टाइप JSON shapes: blocksSnapshot, values, configJson। असली उदाहरणों के लिए export_deck के साथ जोड़ें। | कोई नहीं। |
| list_elevenlabs_voices | generate_audio_for_card पर voice_id के लिए ElevenLabs voice ids और labels। Deckbase का क्यूरेटेड कैटलॉग। उपयोगकर्ता Firestore reads नहीं। | वैकल्पिक language, gender, search। |
| list_ai_image_models | generate_image_for_card के लिए अनुमत AI image model ids, labels और credit costs के साथ। | कोई नहीं। |
| टूल | विवरण | पैरामीटर |
|---|---|---|
| list_decks | उपयोगकर्ता के डेक (deckId, शीर्षक, विवरण, वैकल्पिक defaultTemplateId, वैकल्पिक iconEmoji)। | कोई नहीं। |
| create_deck | डेक बनाएं। deckId, सेट होने पर icon_emoji / iconEmoji लौटाता है। | title (आवश्यक), description (वैकल्पिक), वैकल्पिक icon_emoji या iconEmoji (एकल emoji; जब तक उपयोगकर्ता opt out न करे, AI क्लाइंट्स को शीर्षक के अनुरूप एक चुनना चाहिए)। |
| update_deck | शीर्षक, विवरण, डिफ़ॉल्ट टेम्पलेट या डेक आइकन अपडेट करें। | deckId (आवश्यक); वैकल्पिक title, description, default_template_id, icon_emoji या iconEmoji (खाली स्ट्रिंग आइकन हटा देती है)। |
| list_templates | टेम्पलेट्स (templateId, नाम, विवरण)। | कोई नहीं। |
| get_template_schema | लेआउट का सटीक JSON: blockId, type, side ("front" | "back"), configJson, valuesExample, create_card hints। | templateId या डेक के डिफ़ॉल्ट टेम्पलेट के लिए deckId। |
| create_card | टेम्पलेट से नया कार्ड। cardId, templateId, usedDeckDefault लौटाता है। front मुख्य ब्लॉक भरता है; block_text keys में बैक-फेस ब्लॉक शामिल हैं (side get_template_schema से)। | deckId आवश्यक। वैकल्पिक templateId, front, block_text, generate_audio, voice_id, audio_language, audio_gender। |
| create_cards | बल्क बनाएं। प्रति अनुरोध अधिकतम 50। असफलता पर: created + failedAt। | deckId, cards array (आवश्यक)। वैकल्पिक top-level templateId, voice_id, generate_audio। |
| update_card | कार्ड की सामग्री संपादित करें। | deckId, cardId; वैकल्पिक values / blocks_snapshot, या front / block_text merge करें। |
| delete_card | एक कार्ड soft-delete करें (ट्रैश)। जब तक user_confirmed true न हो, सर्वर मना कर देता है: इसका उपयोग केवल स्पष्ट मानव सहमति के बाद करें। | deckId, cardId, user_confirmed (आवश्यक boolean)। |
| delete_cards | एक ही डेक में बल्क soft-delete। सहमति नियम delete_card जैसा ही। प्रति अनुरोध अधिकतम 50। | deckId, card_ids (non-empty array), user_confirmed। |
| generate_audio_for_card | मौजूदा कार्ड के लिए ElevenLabs TTS। | deckId, cardId। voice_id या audio_language + audio_gender दें। वैकल्पिक text, block_id, replace_existing। |
| export_deck | डेक + कार्ड्स JSON। इसमें truncated, exportType शामिल हैं। पूरा export प्रति-कार्ड blocksSnapshot के साथ side + values शामिल करता है। | deckId (आवश्यक); वैकल्पिक max_cards (डिफ़ॉल्ट 2000, cap 5000), export_type: full या values_only। |
| create_template | नया टेम्पलेट (ब्लॉक लेआउट)। templateId और block ids लौटाता है। block_types छोड़ने पर डिफ़ॉल्ट Q+A। | name (आवश्यक); वैकल्पिक description, block_types / blocks (प्रति-ब्लॉक side), voice_id, audio_language, audio_gender, mainBlockId / subBlockId। |
| update_template | मेटाडेटा और/या लेआउट अपडेट करें। version बढ़ाता है। | templateId (आवश्यक); वैकल्पिक name, description, block_types / blocks, voice_id, audio_language + audio_gender, mainBlockId / subBlockId। |
list_template_block_types और list_block_schemas स्टैटिक डेटा लौटाते हैं (ऑथ ज़रूरी नहीं)। list_elevenlabs_voices Firestore नहीं पढ़ता। बिना प्रमाणीकरण के अनुरोध 401 लौटाते हैं।संसाधन
सर्वर docs/public/ में डॉक्स के लिए MCP resources देता है:
resources/listdocs/public/ में प्रति .md फ़ाइल एक resource (उदा. deckbase://docs/public/MCP.md)।
resources/readउस URI से डॉक सामग्री प्राप्त करें।
उदाहरण: डेक, टेम्पलेट और कार्ड
- 1
अपने क्लाइंट को MCP URL और bearer token से कॉन्फ़िगर करें:
Authorization: Bearer YOUR_API_KEY(या Connect पेज से OAuth access token)। - 2
list_templates कॉल करें। खाली हो तो पहले list_template_block_types और create_template उपयोग करें।
- 3
चुने गए
templateIdके साथ get_template_schema कॉल करें ताकि सटीकblockIdkeys औरsidevalues जान सकें। - 4
title, वैकल्पिकdescriptionऔरicon_emojiके साथ create_deck कॉल करें, जब एजेंट को विषय के अनुरूप आइकन चुनना हो। - 5
deckIdऔर वैकल्पिक रूप सेtemplateId,front(मुख्य ब्लॉक), तथा बैक सहित अन्य ब्लॉकों के लिएblock_textके साथ create_card कॉल करें।
तकनीकी विवरण
क्लाइंट सेटअप (Cursor, VS Code, Claude आदि) के लिए देखें: Deckbase MCP से कनेक्ट करना • अन्य लिंक्स के लिए देखें: संसाधन