Scout Monitoring MCP

Scout Monitoring MCP

इस रिपॉज़िटरी में ऐसा कोड है जिससे स्थानीय रूप से एक MCP सर्वर चलाया जा सकता है, जो Scout के API के ज़रिए Scout Monitoring के डेटा तक पहुँच सकता है। हम एक Docker इमेज उपलब्ध कराते हैं, जिसे आपका AI Assistant Scout Monitoring के डेटा तक पहुँचने के लिए पुल करके चला सकता है।

इससे Scout Monitoring का प्रदर्शन और त्रुटि डेटा सीधे आपके AI Assistant के हाथों में आ जाता है। 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 key दर्ज करना
• MCP सर्वर सेटिंग अपने-आप कॉन्फ़िगर करना

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

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

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

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

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

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

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

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

इंस्टॉलेशन

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

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

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

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

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

{
  "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 Assistant के... हाथों में? पहुँचाने के लिए बनाया गया है। इसका उपयोग लाइन-ऑफ़-कोड जानकारी वाले ट्रेस और त्रुटियाँ पाने के लिए करें, ताकि AI आपके एडिटर में ही सुधारों को लक्षित कर सके।

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

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

• त्रुटि और प्रदर्शन डेटा के आधार पर विस्तृत GitHub/GitLab इश्यू बनाएँ
• JIRA को मज़ेदार बनाएँ—अपने AI Assistant से सभी विवरणों वाले टिकट बनवाएँ
• विशिष्ट त्रुटियों और प्रदर्शन समस्याओं को ठीक करने वाले PR जनरेट करें

टूल

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

• list_apps - उपलब्ध Scout APM एप्लिकेशन की सूची बनाएँ, और चाहें तो पिछली सक्रियता की तारीख के आधार पर फ़िल्टर करें
• get_app_metrics - किसी विशिष्ट एप्लिकेशन के लिए अलग-अलग मेट्रिक डेटा (response_time, throughput आदि) प्राप्त करें
• 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 assistant पढ़कर लागू कर सकता है:

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

उपयोगी प्रॉम्प्ट

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

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

प्रदर्शन और मॉनिटरिंग

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

टोकन उपयोग

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

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

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

Inspector के साथ चलाएँ

uv run task dev

API key जोड़ने और ट्रांसपोर्ट को STDIO पर सेट करने के लिए Inspector में कनेक्ट करें

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)

रिलीज़ प्रकाशित करने पर v* टैग पुश होता है, और CI Docker इमेज, PyPI पैकेज और फिर MCP Registry की प्रविष्टियाँ प्रकाशित करता है:

• server.json → com.scoutapm/scout-mcp-local (यह सर्वर; इसका वर्शन bump_versions.py द्वारा बढ़ाया जाता है)
• server.remote.json → com.scoutapm/scout-monitoring (https://scoutapm.com/mcp पर होस्ट किया गया सर्वर)। इसके version को मेटाडेटा बदलने पर मैन्युअल रूप से बढ़ाएँ; अपरिवर्तित वर्शन छोड़ दिए जाते हैं।

MCP Registry key

Registry, com.scoutapm/* नेमस्पेस के हमारे स्वामित्व की पुष्टि scoutapm.com apex पर मौजूद DNS TXT रिकॉर्ड के ज़रिए करती है, जिसमें Ed25519 सार्वजनिक key होती है। CI, MCP_REGISTRY_PRIVATE_KEY repository secret से मेल खाने वाली निजी key के साथ साइन इन करता है। इसे बदलने के लिए:

openssl genpkey -algorithm Ed25519 -out key.pem
# Public key for the TXT record: replace the existing v=MCPv1 record, don't add a second one
echo "v=MCPv1; k=ed25519; p=$(openssl pkey -in key.pem -pubout -outform DER | tail -c 32 | base64)"
# Private key (hex) for the MCP_REGISTRY_PRIVATE_KEY secret
openssl pkey -in key.pem -noout -text | grep -A3 "priv:" | tail -n +2 | tr -d ' :\n'

बॉट्स के लिए:

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