منصوبے کے بارے میں

fumasignal-mcp ایک تھرڈ پارٹی، غیر سرکاری ماڈل کنٹیکسٹ پروٹوکول (MCP) سرور ہے جس کا مقصد AI اسسٹنٹس کو Fumadocs کے ساتھ بنائے گئے دستاویزاتی مواقع پر تلاش اور پڑھنے کی سہولت دینا ہے۔ یہ یا تو کسی مقرر شدہ Fumadocs URL یا مقامی Fumadocs پروجیکٹ ڈائریکٹری کی طرف اشارہ کرتا ہے اور کسی بھی MCP سپیکنگ کلائنٹ کے لیے پڑھنے کے صرف ٹولز کا سیٹ ظاہر کرتا ہے۔ پروجیکٹ کا نام Fumadocs آرتھر ہینڈل fuma-nama اور اس خیال پر مبنی ہے کہ دھوئیں کے اشارے AI کلائنٹ اور بیرونی ٹول کے درمیان پیغامات بھیجتے ہیں۔ مصنف نے واضح طور پر کہا ہے کہ یہ Fumadocs پروجیکٹ سے منسلک نہیں ہے۔ آپریٹنگ موڈز سرور دو موڈز میں چلتا ہے۔ ریموٹ موڈ میں آپ کو کسی مقرر شدہ Fumadocs سائٹ کا اصل ذریعہ فراہم کرنا ہوتا ہے (سکیم اور ہوسٹ صرف، دستاویزی راستہ الگ سے ترتیب دیا جاتا ہے)، جس کے لیے کسی مقامی سیٹ اپ کی ضرورت نہیں ہوتی۔ مقامی موڈ میں آپ اسے ڈسک پر کسی Fumadocs پروجیکٹ رول کی طرف اشارہ کرتے ہیں، جو آف لائن کام یا پری ڈپلائی چیکنگ کے لیے موزوں ہے۔ یہ ایک واحد npx بائنری کے طور پر تقسیم کیا جاتا ہے، لہذا عام انویکیشن npx -y fumasignal-mcp --url https://your-docs.com ہے، اور تمام رسائی کو پڑھنے کے صرف کے طور پر بیان کیا جاتا ہے، دستاویزات کو کبھی بھی تبدیل نہیں کرتا۔ نامزد ٹولز سات ٹولز فراہم کیے جاتے ہیں۔ search_docs سائٹ کے Orama سرچ API کے ذریعے فل ٹیکسٹ سرچ انجام دیتا ہے اور کueri کی ضرورت ہوتی ہے؛ یہ مخصوص دستاویزی مواقع کے لیے ٹیگ آرگومنٹ بھی قبول کرتا ہے۔ list_pages معلوم دستاویزی صفحات کی فہرست تیار کرتا ہے اور URL پریفکس سے فلٹر کیا جا سکتا ہے۔ get_page کسی صفحے کا مکمل مارک ڈاؤن مواد حاصل کرتا ہے۔ get_section ہیڈنگ اینکر سے شناخت شدہ ایک اکیلا سیکشن حاصل کرتا ہے۔ get_toc کسی صفحے کے ہیڈنگز اور ان کے اینکرز کی فہرست تیار کرتا ہے۔ get_meta فرنٹ میٹر یا صفحے کا میٹا ڈیٹا JSON کے طور پر واپس کرتا ہے۔ get_llms_txt llms.txt حاصل کرتا ہے، یا جب فل آپشن سیٹ ہو تو llms-full.txt۔ صفحہ حوالہ جات کو URL راستے، مطلق سیم ہوسٹ URL، یا docs پریفکس کے تحت slug کے طور پر دیا جا سکتا ہے۔ کلائنٹ ترتیب README میں Claude Desktop، Claude Code，Cursor، VS Code with GitHub Copilot Chat، اور Continue.dev کے لیے ترتیب کے مسودے دستاویزی ہیں، جن میں stdio ٹرانسپورٹ اور ہر صورت میں ایک ہی npx کمانڈ استعمال ہوتی ہے۔ مختلف دستاویزی مواقع کو مختلف کلیدیوں کے تحت متعدد مثالیں رجسٹر کر کے فراہم کیا جا سکتا ہے۔ Continue.dev کے لیے، ایک قابلِ重用 JSON فائل اور نیٹو YAML فارمیٹ دونوں دکھائے گئے ہیں۔ ترتیب فلیگز اور ماحولیاتی متغیرات CLI فلیگز میں سائٹ اصل کے لیے --url، مقامی پروجیکٹ رول کے لیے --local، غیر معمولی سرچ API راستے کے لیے --search-path (ڈیفالٹ /api/search، ہمیشہ اصل رول سے حل ہوتا ہے)، دستاویزی URL پریفکس کے لیے --docs-prefix (ڈیفالٹ /docs)، مقامی مواد ڈائریکٹری کے لیے --content-dir (ڈیفالٹ content/docs)، تصدیق شدہ مواقع کے لیے --auth-header، ریموٹ ریسنس کشنگ کے لیے --cache-ttl (ڈیفالٹ 300000 ملی سیکنڈ)، اور --version اور --help شامل ہیں۔ ہر فلیگ کا ایک متعلقہ FUMASIGNAL_* ماحولیاتی متغیر ہے، جس میں واضح فلیگز کو ترجیح حاصل ہے، اور ایک اضافی FUMASIGNAL_LOG_LEVEL سیٹنگ ہے جس کا کوئی فلیگ متبادل نہیں ہے۔ README رازوں کو ماحولیاتی متغیر کے ذریعے گزرنے کی سفارش کرتا ہے تاکہ وہ شیل تاریخ یا پروسیس فہرستوں میں قائم نہ رہیں۔ ریٹریول کیسے کام کرتا ہے ریموٹ موڈ میں، سرچ سائٹ کے Orama API کو کال کرتا ہے اور فلیٹ آری اور ہٹس/دستاویز ریسنس شیکپس دونوں کو ہینڈلز کرتا ہے؛ صفحات کی فہرست sitema.xml کو کشید کرتا ہے اور docs پریفکس کے ذریعے فلٹر کرتا ہے؛ صفحہ ریٹریول پہلے .md، .mdx اور /raw ورینٹس کی کوشش کرتا ہے اور ورنہ رینڈر شدہ HTML کو سکرپ کریں اور Turndown کے ساتھ مضمون یا مرکزی عنصر کو Markdown میں تبدیل کریں؛ llms.txt براہ راست کشید کیا جاتا ہے۔ ریموٹ ریسنس پانچ منٹ کے ڈیفالٹ TTL کے ساتھ میموری میں کش کیا جاتا ہے۔ مقامی موڈ میں سرور مواد ڈائریکٹری کے تحت مارک ڈاؤن اور MDX فائلز کو ٹھہراتا ہے، gray-matter کے ساتھ فرنٹ میٹر کو پارس کرتا ہے، انڈیکس فائلز کو docs رول سے میپ کرتا ہے، اور ہیڈنگ کے وزن والے ٹوکن میچنگ کے ذریعے سرچ ریسنٹس کو سکور کرتا ہے۔ مطابقت اور ٹیسٹنگ پروجیکٹ کو Node.js 20 یا بعد کے ورژن کی ضرورت ہوتی ہے، یہ دعویٰ کرتا ہے کہ اس کا ٹیسٹ ڈیفالٹ Orama سرچ API اور معیاری سائٹ میپ لی آوٹ کے ساتھ کیا گیا ہے، اور یہ کہتا ہے کہ یہ کسی بھی STDIO MCP کلائنٹ کے ساتھ کام کرتا ہے، Claude Desktop، Claude Code، Cursor، VS Code آپشنز، Zed اور Cline سمیت نامزد کرتا ہے۔ یہ 280 سے زائد یونٹ ٹیسٹس کے ساتھ فیچرٹس فراہم کرتا ہے جو سرچ، سائٹ میپ اور HTML راستوں کو کور کرتے ہیں۔ بلواس اور ترقی README عام مسائل کو کور کرتا ہے: ایک مفقود سائٹ میپ صرف list_pages کو متاثر کرتا ہے، سرچ پر 404 عام طور پر غیر معمولی سرچ راستے یا راستہ سمیت URL کی وجہ سے ہوتا ہے، HTML سکرپنگ مارک ڈاؤن اینڈ پوائنٹس والے مواقع پر شور پیدا کر سکتی ہے، اور ایک MCP انسپکٹر اسکرپٹ فراہم کیا گیا ہے تاکہ تصدیق کی جا سکے کہ ٹولز درست طریقے سے رجسٹر ہوتے ہیں۔ ترقی کے ہدایات میں کلوننگ، انسٹال کرنا، tsc کے ساتھ ٹائپ چیک کرنا، eslint کے ساتھ لنٹ کرنا، vitest کے ساتھ ٹیسٹ کرنا، tsup کے ساتھ بلڈ کرنا، اور ایک کمبائنڈ چیک اسکرپٹ شامل ہیں۔ شراکت دعوت دی گئی ہے، غیر معمولی تبدیلیوں کے لیے پہلے ایک مسئلہ کھولنے کی درخواست کے ساتھ۔ پروجیکٹ MIT لائسنس کے تحت جاری کیا جاتا ہے۔