इस प्रोजेक्ट के बारे में

MCP Inspector एक डेवलपर-केंद्रित टूल है जो Model Context Protocol (MCP) सर्वरों का निरीक्षण और परीक्षण करने के लिए बनाया गया है। यह `@modelcontextprotocol/inspector` नामक एकल npm पैकेज के रूप में आता है और एक वैश्विक बाइनरी `mcp-inspector` उजागर करता है जो तीन मोड में चलती है: - **वेब** — Vite + React + Mantine का उपयोग करने वाला एकल-पृष्ठ अनुप्रयोग जिसमें Node.js बैकएंड है, जो सर्वर निरीक्षण के लिए दृश्य इंटरफेस प्रदान करता है। - **CLI** — स्वचालन, CI पाइपलाइनों और तेज एजेंट फीडबैक लूप के लिए डिज़ाइन किया गया स्क्रिप्टेबल कमांड-लाइन क्लाइंट। - **TUI** — Ink का उपयोग करके बना इंटरैक्टिव टर्मिनल UI उन उपयोगकर्ताओं के लिए जो टर्मिनल-आधारित कार्यप्रवाह को प्राथमिकता देते हैं। तीनों मोड समान बाइनरी को फ्लैग के साथ निष्पादित करके आह्वान किए जाते हैं: ```bash npx @modelcontextprotocol/inspector # वेब UI (डिफ़ॉल्ट) npx @modelcontextprotocol/inspector --cli # CLI मोड npx @modelcontextprotocol/inspector --tui # TUI मोड ``` ## अभियांत्रिकी यह परियोजना npm वर्कस्पेस नहीं है। `clients/` के प्रत्येक क्लाइंट का अपना `package.json` और `node_modules` होता है। साझा कोड `core/` में रहता है और `@inspector/core` बिल्ड-टाइम एलियास के माध्यम से खपत होता है। `core/` द्वारा आयातित रनटाइम निर्भरताएँ रिपॉज़िटरी रूट पर एक बार घोषित की जाती हैं, जबकि प्रत्येक क्लाइंट केवल अपना UI स्टैक, बंडलर-इन्लाइन पैकेज और डेव टूलिंग घोषित करता है। `clients/cli` और `clients/launcher` पैकेजों के अपने कोई रनटाइम निर्भरताएँ नहीं हैं। ## परियोजना लेआउट - `clients/web/` — वेब क्लाइंट (Vite + React + Mantine)। `src/` निर्देशिका में ब्राउज़र एप है; `server/` Node बैकएंड को संभालता है। - `clients/cli/` — CLI क्लाइंट, `@inspector/core` एलियास के साथ tsup का उपयोग करके बंडल किया गया। - `clients/tui/` — TUI क्लाइंट, Ink + React से बना और tsup के साथ बंडल किया गया। - `clients/launcher/` — साझा लॉन्चर जो `mcp-inspector` बाइनरी प्रदान करता है और उचित क्लाइंट की ओर भेजता है। - `core/` — साझा कोड जो `@inspector/core` एलियास के माध्यम से खपत होता है; इसमें `package.json` नहीं है। - `test-servers/` — इंटिग्रेशन और स्मोक टेस्ट में उपयोग की जाने वाली संयोज्य MCP टेस्ट सर्वर और फिक्स्चर। - `scripts/` — रूट बिल्ड और सत्यापन टूलिंग, जिसमें इंस्टॉल कैस्केड, स्मोक टेस्ट और CI स्वचालन शामिल हैं। - `docs/` — अभियांत्रिकी, परीक्षण, गुणवत्ता गेट, राजस्व संचयन, प्रवासन, Docker उपयोग आदि को कवर करने वाले कार्य-उन्मुख मार्गदर्शक। - `specification/` — डिज़ाइन और निर्माण विनिर्देश। - `.claude/skills/` — एजेंट कौशल, प्रत्येक अपने निर्देशिका में, प्रक्रिया नाम से आवश्यकतानुसार लोड होते हैं। ## विकास कार्यप्रवाह Node `>=22.19.0` आवश्यक है। रिपॉज़िटरी रूट पर `npm install` चलाने के बाद (जिसका postinstall स्क्रीप्ट प्रत्येक क्लाइंट में कैस्केड होता है), क्रमशः वेब, CLI, TUI और लॉन्चर को कंपाइल करने के लिए `npm run build` चलाएं। तीव्र वेब विकास के लिए, आप लॉन्चर को पुनर्निर्मित किए बिना तेज हॉट-मॉड्यूल रिप्लेसमेंट के लिए `clients/web` से सीधे Vite चला सकते हैं। अनिवार्य प्री-पुश गेट `npm run local:gate` है, जो फॉर्मेट जांच, लीडिंग, टाइप-जांच, बिल्ड, यूनिट टेस्ट, कवरेज सत्यापन (प्रति-फ़ाइल 90% threshold), स्मोक टेस्ट और Storybook टेस्ट को चेन करता है। यह GitHub CI जांच को स्थानीय रूप से दर्शाता है। ## दस्तावेज़ीकरण उल्लेखनीय बिंदु - **अभियांत्रिकी** — साझा `@inspector/core` पैकेज और वेब क्लाइंट घटक मॉडल पर विवरण। - **परीक्षण और गुणवत्ता गेट** — प्रत्येक मान्यता स्क्रीप्ट क्या सत्यापित करती है और CI-वि-स्थानीय गेट विभाजन का कवरेज। - **राजस्व संचयन** — OS keychains, प्लेनटेक्स्ट फ़ाइलों और इन-मेमोरी स्टोर में राजस्व का प्रबंधन कैसे किया जाता है, जिसमें एन्क्रिप्शन और लॉकिंग शामिल हैं। - **MCP सर्वर का स्मोक-टेस्ट** — शेल या CI जॉब के लिए कनेक्ट → सूची → कॉल → प्रतिफलाने का कार्यप्रवाह, JSON आउटपुट और एक्ज़िट-कोड मैपिंग के साथ। - **v1 से v2 में प्रवास** — CLI फ्लैग परिवर्तन, `--config` बनाम `--catalog` विभाजन, Node इंजन बढ़त और env-वेरिएबल नाम बदलाव। - **रोडमैप** — प्रकाशित MCP रोडमैप के अनुरूप छह-मासिक योजना, जिसमें स्पेक अनुपालन, आधिकारिक एक्सटेंशन समर्थन और अनुभव सुधार शामिल हैं। ## योगदान योगदान समस्या-चालित कार्यप्रवाह का पालन करते हैं। सभी कार्य v2 प्रोजेक्ट बोर्ड पर ट्रैक किया जाना चाहिए, PRs को `v2/main` के खिलाफ खोला जाए और `Closes #<issue>` के साथ लिंक किया जाए। बाहरी योगदान को PRs के बजाय समस्याओं के रूप में स्वीकार किया जाता है। `AGENTS.md` फ़ाइल मानव और AI दोनों योगदानकर्ताओं के लिए परियोजना के नियम परिभाषित करती है, जिसमें वर्जनنگ, TypeScript मानक, Mantine/React अभ्यास और परीक्षण आवश्यकताएँ शामिल हैं। `CLAUDE.md` फ़ाइल Claude Code के लिए प्रवेश बिंदु के रूप में कार्य करती है, स्वचालित रूप से `AGENTS.md` लोड करती है ताकि एजेंट और मानव दोनों समान सत्य स्रोत से कार्य करें। ## लाइसेंस MCP परियोजना MIT से Apache-2.0 में परिवर्तित हो रही है। नए योगदान Apache-2.0 के तहत लाइसेंसित हैं, दस्तावेज़ीकरण (विनिर्देश除外) CC-BY-4.0 के तहत है, और वह पुराने योगदान जिन्होंने पुनः-लाइसेंस सहमति नहीं दी है वे MIT के तहत ही रहते हैं।