Scout Monitoring MCP Server

Scout Monitoring MCP

यह रिपॉजिटरी एक MCP सर्वर को स्थानीय रूप से चलाने के लिए कोड रखती है जो Scout की API के माध्यम से Scout Monitoring डेटा तक पहुँच सकता है। हम एक Docker इमेज प्रदान करते हैं जिसे आपका AI असिस्टेंट Scout Monitoring डेटा तक पहुँचने के लिए खींच और चला सकता है।

यह Scout Monitoring के प्रदर्शन और त्रुटि डेटा को सीधे आपके AI असिस्टेंट के हाथों में देता है। Rails, Django, FastAPI, Laravel और अधिक के लिए। इसका उपयोग कोड-की-पंक्ति जानकारी के साथ ट्रेस और त्रुटियाँ प्राप्त करने के लिए करें जिसका AI आपके संपादक और कोडबेस में सीधे सुधारों को लक्षित करने के लिए उपयोग कर सकता है। N+1 क्वेरीज़, धीमे एंडपॉइंट, धीमी क्वेरीज़, मेमोरी ब्लोट, थ्रूपुट समस्याएँ - आपकी सभी पसंदीदा प्रदर्शन समस्याएँ ठीक वहीं सामने आती हैं और समझाई जाती हैं जहाँ आप काम कर रहे हैं।

अगर यह आपके जीवन को थोड़ा बेहतर बनाता है, तो क्यों न इसे :star: करें?!

सेटअप विज़ार्ड

Scout MCP को कॉन्फ़िगर और उपयोग शुरू करने का सबसे सरल तरीका हमारे इंटरैक्टिव सेटअप विज़ार्ड के साथ है। यह आपके लिए सभी पूर्वापेक्षाएँ और स्थापना चरणों को संभालता है।

npx के माध्यम से चलाएँ:

npx @scout_apm/wizard

स्रोत से बनाएँ और चलाएँ:

cd ./wizard
npm install
npm run build
node dist/wizard.js

विज़ार्ड आपको इनके माध्यम से मार्गदर्शन करेगा:

• अपना AI कोडिंग प्लेटफ़ॉर्म चुनना (Cursor, Claude Code, Claude Desktop)
• अपनी Scout API कुंजी दर्ज करना
• MCP सर्वर सेटिंग्स को स्वचालित रूप से कॉन्फ़िगर करना

समर्थित प्लेटफ़ॉर्म

विज़ार्ड वर्तमान में इनके लिए सेटअप का समर्थन करता है:

• Cursor - MCP सेटिंग्स को स्वचालित रूप से कॉन्फ़िगर करता है
• Claude Code (CLI) - चलाने के लिए सही कमांड प्रदान करता है
• Claude Desktop - Windows/Mac के लिए कॉन्फ़िगरेशन फ़ाइल को अपडेट करता है

अन्य सभी के लिए, यह JSON आउटपुट करेगा जिसे आप अपने AI असिस्टेंट के MCP कॉन्फ़िगरेशन में कॉपी/पेस्ट कर सकते हैं।

पूर्वापेक्षाएँ

विज़ार्ड शुरू करने का एक शानदार तरीका है, लेकिन आप चीज़ों को मैन्युअल रूप से भी सेट कर सकते हैं। आपको एक Scout Monitoring खाता रखना या बनाना होगा और एक API कुंजी प्राप्त करनी होगी।

1. साइन अप करें
2. अपने एप्लिकेशन में Scout एजेंट स्थापित करें और Scout डेटा भेजें!
   • Ruby
   • Python
   • PHP
   • यदि आप इसे स्थानीय रूप से आज़मा रहे हैं, तो सुनिश्चित करें कि सर्वोत्तम अनुभव के लिए आपके कॉन्फ़िग में monitor: true, errors_enabled: true सेट हैं
3. API कुंजी प्राप्त करने या बनाने के लिए सेटिंग्स पर जाएँ
   • यह आपकी "एजेंट कुंजी" नहीं है; यह "API कुंजी" है जिसे सेटिंग्स पृष्ठ पर बनाया जा सकता है
   • यह एक केवल-पढ़ने की कुंजी है जो केवल आपके खाते के डेटा तक पहुँच सकती है
4. Docker स्थापित करें। नीचे दिए गए निर्देश मानते हैं कि आप एक Docker कंटेनर शुरू कर सकते हैं

MCP सर्वर वर्तमान में बिना API कुंजी सेट के शुरू नहीं होगा, चाहे वह पर्यावरण में हो या स्टार्टअप पर कमांड-लाइन तर्क द्वारा।

स्थापना

हम MCP सर्वर चलाने के लिए प्रदान की गई Docker इमेज का उपयोग करने की सलाह देते हैं। यह आपके AI असिस्टेंट द्वारा शुरू किया जाना और आपकी Scout API कुंजी के साथ कॉन्फ़िगर किया जाना है। कई स्थानीय क्लाइंट किसी स्थान पर MCP सर्वर चलाने के लिए एक कमांड निर्दिष्ट करने की अनुमति देते हैं। कुछ उदाहरण नीचे दिए गए हैं।

Docker इमेज Docker Hub पर उपलब्ध है।

बेशक, आप हमेशा इस रिपो को क्लोन कर सकते हैं और MCP सर्वर को सीधे चला सकते हैं; uv या अन्य पर्यावरण प्रबंधन उपकरणों की सिफारिश की जाती है।

एक स्थानीय क्लाइंट कॉन्फ़िगर करें (जैसे Claude/Cursor/VS Code Copilot)

यदि आप MCP को मैन्युअल रूप से कॉन्फ़िगर करना चाहते हैं, तो इसका आमतौर पर मतलब है अपने AI असिस्टेंट के कॉन्फ़िग में पर्यावरण में आपकी API कुंजी के साथ MCP सर्वर चलाने के लिए एक कमांड प्रदान करना। यहाँ JSON का आकार है (शीर्ष-स्तरीय कुंजी भिन्न होती है):

{
  "mcpServers": {
    "scout-apm": {
      "command": "docker",
      "args": ["run", "--rm", "-i", "--env", "SCOUT_API_KEY", "scoutapp/scout-mcp-local"],
      "env": { "SCOUT_API_KEY": "your_scout_api_key_here"}
    }
  }
}

claude mcp add scoutmcp -e SCOUT_API_KEY=your_scout_api_key_here -- docker run --rm -i -e SCOUT_API_KEY scoutapp/scout-mcp-local

{
  "mcpServers": {
    "scout-apm": {
      "command": "docker",
      "args": ["run", "--rm", "-i", "--env", "SCOUT_API_KEY", "scoutapp/scout-mcp-local"],
      "env": { "SCOUT_API_KEY": "your_scout_api_key_here"}
    }
  }
}

Scout Monitoring MCP का उपयोग करना

Scout का MCP त्रुटि और प्रदर्शन डेटा को सीधे आपके AI असिस्टेंट के... हाथों में? देने के लिए है। इसका उपयोग कोड-की-पंक्ति जानकारी के साथ ट्रेस और त्रुटियाँ प्राप्त करने के लिए करें जिसका AI आपके संपादक में सीधे सुधारों को लक्षित करने के लिए उपयोग कर सकता है।

अधिकांश असिस्टेंट आपको कच्चे टूल कॉल दिखाएंगे और विश्लेषण करेंगे। डेस्कटॉप असिस्टेंट आपके इच्छित किसी भी डेटा का पता लगाने के लिए आसानी से कस्टम JS एप्लिकेशन बना सकते हैं। कोड संपादकों में एकीकृत असिस्टेंट आपके कोडबेस में सीधे सुधार करने के लिए ट्रेस डेटा और त्रुटि बैकट्रेस का उपयोग कर सकते हैं।

Scout के MCP को अपने AI असिस्टेंट के अन्य उपकरणों के साथ मिलाकर:

• त्रुटियों और प्रदर्शन डेटा के आधार पर समृद्ध GitHub/GitLab मुद्दे बनाएँ
• JIRA को मज़ेदार बनाएँ - अपने AI असिस्टेंट से सभी विवरणों के साथ टिकट बनवाएँ
• ऐसे PR उत्पन्न करें जो विशिष्ट त्रुटियों और प्रदर्शन समस्याओं को ठीक करते हैं

उपकरण

Scout MCP, Scout APM डेटा तक पहुँचने के लिए निम्नलिखित उपकरण प्रदान करता है:

• list_apps - उपलब्ध Scout APM एप्लिकेशनों की सूची बनाएँ, अंतिम सक्रिय तिथि के अनुसार वैकल्पिक फ़िल्टरिंग के साथ
• get_app_metrics - किसी विशिष्ट एप्लिकेशन के लिए व्यक्तिगत मीट्रिक डेटा (प्रतिक्रिया_समय, थ्रूपुट, आदि) प्राप्त करें
• get_app_endpoints - एकत्रित प्रदर्शन मीट्रिक्स के साथ किसी एप्लिकेशन के सभी एंडपॉइंट प्राप्त करें
• get_endpoint_metrics - किसी एप्लिकेशन में किसी विशिष्ट एंडपॉइंट के लिए टाइमसीरीज़ मीट्रिक्स प्राप्त करें
• get_app_endpoint_traces - किसी विशिष्ट एंडपॉइंट पर फ़िल्टर किए गए ऐप के लिए हाल के ट्रेस प्राप्त करें
• get_app_trace - सभी स्पैन और विस्तृत निष्पादन जानकारी के साथ एक व्यक्तिगत ट्रेस प्राप्त करें
• get_app_error_groups - किसी ऐप के लिए हाल के त्रुटि समूह प्राप्त करें, वैकल्पिक रूप से एंडपॉइंट द्वारा फ़िल्टर किया गया
• get_app_insights - N+1 क्वेरीज़, मेमोरी ब्लोट और धीमी क्वेरीज़ सहित प्रदर्शन अंतर्दृष्टि प्राप्त करें

संसाधन

Scout MCP कॉन्फ़िगरेशन टेम्पलेट्स को संसाधनों के रूप में प्रदान करता है जिन्हें आपका AI असिस्टेंट पढ़ और लागू कर सकता है:

• scoutapm://config-resources/{framework} - समर्थित फ्रेमवर्क या लाइब्रेरी (rails, django, flask, fastapi) के लिए सेटअप निर्देश
• scoutapm://config-resources/list - सभी उपलब्ध कॉन्फ़िगरेशन टेम्पलेट्स की सूची बनाएँ
• scoutapm://metrics - Scout APM के लिए सभी उपलब्ध मीट्रिक्स की सूची

उपयोगी संकेत

सेटअप और कॉन्फ़िगरेशन

• "मेरे Rails एप्लिकेशन के लिए Scout निगरानी सेट करने में मेरी मदद करें"
• "कुंजी ABC123 के साथ मेरे Django प्रोजेक्ट के लिए एक Scout APM कॉन्फ़िग फ़ाइल बनाएँ"

प्रदर्शन और निगरानी

• "Scout Monitoring MCP में उपलब्ध उपकरणों का सारांश दें।"
• "पिछले 7 दिनों में ऐप my-app-name के लिए सबसे धीमे एंडपॉइंट खोजें। औसत प्रतिक्रिया समय, थ्रूपुट और P95 प्रतिक्रिया समय सहित परिणामों के साथ एक तालिका उत्पन्न करें।"
• "पिछले 24 घंटों में ऐप Foo के लिए उच्चतम-आवृत्ति त्रुटियाँ दिखाएँ। नवीनतम त्रुटि विवरण प्राप्त करें, बैकट्रेस की जाँच करें और एक सुधार सुझाएँ।"
• "ऐप Bar के लिए कोई हालिया n+1 अंतर्दृष्टि प्राप्त करें। आईडी द्वारा विशिष्ट ट्रेस खींचें और बैकट्रेस डेटा के आधार पर इसे अनुकूलित करने में मेरी मदद करें।"

टोकन उपयोग

हम वर्तमान में अपने MCP उपकरणों से प्रतिक्रिया आकार को सख्ती से नियंत्रित करने की तुलना में उपलब्ध जानकारी का विस्तार करने में अधिक रुचि रखते हैं। यदि आपके AI असिस्टेंट की एक कॉन्फ़िगर करने योग्य टोकन सीमा है (जैसे Claude Code export MAX_MCP_OUTPUT_TOKENS=50000), तो हम इसे उदारतापूर्वक उच्च सेट करने की सलाह देते हैं, जैसे 50,000 टोकन।

स्थानीय विकास

हम इस परियोजना के लिए वातावरण प्रबंधित करने और कार्य चलाने के लिए uv और taskipy का उपयोग करते हैं।

इंस्पेक्टर के साथ चलाएँ

uv run task dev

API कुंजी जोड़ने के लिए इंस्पेक्टर के भीतर कनेक्ट करें, STDIO परिवहन पर सेट करें

Docker इमेज बनाएँ

docker build -t scout-mcp-local .

रिलीज़

1. uv run python bump_versions.py के साथ शाखा बनाएँ और संस्करण बढ़ाएँ
2. इसे मर्ज करवाएँ
3. नए संस्करण के साथ एक GitHub रिलीज़ बनाएँ (gh release create v2025.11.3 --generate-notes --draft)

बॉट्स के लिए:

mcp-name: com.scoutapm/scout-mcp-local