Ragdocs

Ragdocs предоставляет ИИ-ассистентам контекст документации с помощью векторного поиска. Улучшайте ответы LLM с актуальной информацией в реальном времени. Поддержка множества источников, семантический поиск и многое другое!

Data Science и ML Инструменты разработчика Обучение и документация ★ 93 GitHub (93 ★)

Ragdocs — реализация, которая наделяет ИИ-ассистентов способностью улучшать свои ответы, используя релевантный контекст документации. Это достигается с помощью векторного поиска и извлечения информации, что обеспечивает семантическое понимание и точное извлечение данных из хранимой документации. Сервер обеспечивает дополнение контекста LLM в реальном времени, позволяя разработчикам создавать инструменты ИИ, осведомлённые о документации, и реализовывать семантический поиск по документации.

Ключевые возможности

01Поддержка нескольких источников документации

02Возможности семантического поиска

03Автоматическая обработка документации

0493 звезды на GitHub

05Векторный поиск и извлечение документации

06Дополнение контекста LLM в реальном времени

Варианты использования

01Создание ИИ-ассистентов, осведомлённых о документации

02Создание контекстно-зависимых инструментов для разработчиков

03Улучшение ответов ИИ с помощью релевантной документации

RAG Documentation MCP Server

An MCP server implementation that provides tools for retrieving and processing documentation through vector search, enabling AI assistants to augment their responses with relevant documentation context.

Features

Vector-based documentation search and retrieval
Support for multiple documentation sources
Semantic search capabilities
Automated documentation processing
Real-time context augmentation for LLMs

Tools

search_documentation

Search through stored documentation using natural language queries. Returns matching excerpts with context, ranked by relevance.

Inputs:

query (string): The text to search for in the documentation. Can be a natural language query, specific terms, or code snippets.
limit (number, optional): Maximum number of results to return (1-20, default: 5). Higher limits provide more comprehensive results but may take longer to process.

list_sources

List all documentation sources currently stored in the system. Returns a comprehensive list of all indexed documentation including source URLs, titles, and last update times. Use this to understand what documentation is available for searching or to verify if specific sources have been indexed.

extract_urls

Extract and analyze all URLs from a given web page. This tool crawls the specified webpage, identifies all hyperlinks, and optionally adds them to the processing queue.

Inputs:

url (string): The complete URL of the webpage to analyze (must include protocol, e.g., https://). The page must be publicly accessible.
add_to_queue (boolean, optional): If true, automatically add extracted URLs to the processing queue for later indexing. Use with caution on large sites to avoid excessive queuing.

remove_documentation

Remove specific documentation sources from the system by their URLs. The removal is permanent and will affect future search results.

Inputs:

urls (string[]): Array of URLs to remove from the database. Each URL must exactly match the URL used when the documentation was added.

list_queue

List all URLs currently waiting in the documentation processing queue. Shows pending documentation sources that will be processed when run_queue is called. Use this to monitor queue status, verify URLs were added correctly, or check processing backlog.

run_queue

Process and index all URLs currently in the documentation queue. Each URL is processed sequentially, with proper error handling and retry logic. Progress updates are provided as processing occurs. Long-running operations will process until the queue is empty or an unrecoverable error occurs.

clear_queue

Remove all pending URLs from the documentation processing queue. Use this to reset the queue when you want to start fresh, remove unwanted URLs, or cancel pending processing. This operation is immediate and permanent - URLs will need to be re-added if you want to process them later.

Usage

The RAG Documentation tool is designed for:

Enhancing AI responses with relevant documentation
Building documentation-aware AI assistants
Creating context-aware tooling for developers
Implementing semantic documentation search
Augmenting existing knowledge bases

Configuration

Usage with Claude Desktop

Add this to your claude_desktop_config.json:

{
  "mcpServers": {
    "rag-docs": {
      "command": "npx",
      "args": [
        "-y",
        "@hannesrudolph/mcp-ragdocs"
      ],
      "env": {
        "OPENAI_API_KEY": "",
        "QDRANT_URL": "",
        "QDRANT_API_KEY": ""
      }
    }
  }
}

You'll need to provide values for the following environment variables:

OPENAI_API_KEY: Your OpenAI API key for embeddings generation
QDRANT_URL: URL of your Qdrant vector database instance
QDRANT_API_KEY: API key for authenticating with Qdrant

License

This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.

Acknowledgments

This project is a fork of qpd-v/mcp-ragdocs, originally developed by qpd-v. The original project provided the foundation for this implementation.

MCP-сервер RAGdocs — семантический поиск по документации

Сервер RAGdocs реализует протокол MCP (Model Context Protocol) и предоставляет набор инструментов для индексации, поиска и управления документацией с помощью векторного поиска. Он позволяет AI-ассистентам находить релевантные фрагменты документации по смыслу и добавлять их в контекст своих ответов.

Возможности

Векторный поиск по документации на естественном языке
Поддержка множества источников документации (веб-страницы)
Семантическое ранжирование результатов
Автоматическая обработка и индексация URL-адресов
Управление очередью на обработку

Предварительные требования

Для работы сервера необходимы:

Node.js (утилита npx)
API-ключ OpenAI (для генерации эмбеддингов)
Экземпляр векторной базы данных Qdrant с URL и API-ключом

Установка и настройка (Claude Desktop)

Добавьте следующую конфигурацию в файл claude_desktop_config.json:

{
  "mcpServers": {
    "rag-docs": {
      "command": "npx",
      "args": [
        "-y",
        "@hannesrudolph/mcp-ragdocs"
      ],
      "env": {
        "OPENAI_API_KEY": "ваш_ключ",
        "QDRANT_URL": "https://ваш-экземпляр.qdrant.io",
        "QDRANT_API_KEY": "ваш_ключ_qdrant"
      }
    }
  }
}

Замените значения в env на свои учётные данные.

Инструменты

Сервер предоставляет семь инструментов для работы с документацией.

`search_documentation`

Выполняет семантический поиск по проиндексированным документам. Возвращает фрагменты текста с контекстом, отсортированные по релевантности.

Входные параметры:

query (строка, обязательный) — поисковый запрос на естественном языке, термин или фрагмент кода.
limit (число, опционально) — максимальное количество результатов (от 1 до 20, по умолчанию 5). Большее значение даёт более полные результаты, но может работать дольше.

`list_sources`

Выводит список всех источников документации, которые уже проиндексированы: их URL, заголовки и время последнего обновления. Удобно для проверки, какие материалы доступны для поиска.

`extract_urls`

Извлекает все гиперссылки с указанной веб-страницы и (опционально) добавляет их в очередь на обработку.

Входные параметры:

url (строка, обязательный) — полный URL страницы (с протоколом, например https://...). Страница должна быть публично доступна.
add_to_queue (булево, опционально) — если true, извлечённые URL автоматически ставятся в очередь для последующей индексации. С осторожностью на больших сайтах.

`remove_documentation`

Удаляет указанные источники документации из базы данных по их URL. Удаление постоянно — восстановить данные можно только повторной индексацией.

Входные параметры:

urls (массив строк) — список URL для удаления. Каждый URL должен в точности совпадать с тем, который использовался при добавлении.

`list_queue`

Показывает URL, ожидающие обработки в очереди. Полезно для мониторинга статуса, проверки правильности добавления URL или оценки объёма необработанной документации.

`run_queue`

Запускает последовательную обработку и индексацию всех URL из очереди. Каждый URL обрабатывается с повторными попытками при ошибках. Выполняется, пока очередь не опустеет или не возникнет неисправимая ошибка.

`clear_queue`

Очищает всю очередь URL немедленно и безвозвратно. Используйте, чтобы начать с чистого листа, удалить нежелательные URL или отменить ожидающую обработку.

Сценарии использования

Улучшение ответов AI-ассистента за счёт актуальной документации
Создание «документированных» AI-агентов, которые могут ссылаться на конкретные источники
Разработка инструментов с контекстной подсказкой на основе документации
Семантический поиск по технической документации
Дополнение существующих баз знаний

Лицензия

Сервер распространяется под лицензией MIT. Подробности — в файле LICENSE в репозитории проекта.

Благодарности

Этот проект является форком qpd-v/mcp-ragdocs, первоначально разработанного qpd-v. Оригинальный проект послужил основой для данной реализации.

Источник: https://mcpmarket.com/server/ragdocs-1

Ragdocs

Ключевые возможности

Варианты использования

RAG Documentation MCP Server

Features

Tools

search_documentation

list_sources

extract_urls

remove_documentation

list_queue

run_queue

clear_queue

Usage

Configuration

Usage with Claude Desktop

License

Acknowledgments

MCP-сервер RAGdocs — семантический поиск по документации

Возможности

Предварительные требования

Установка и настройка (Claude Desktop)

Инструменты

`search_documentation`

`list_sources`

`extract_urls`

`remove_documentation`

`list_queue`

`run_queue`

`clear_queue`

Сценарии использования

Лицензия

Благодарности

Что такое Ragdocs?

Как работает Ragdocs?

Какие типы источников документации поддерживает Ragdocs?

Каковы преимущества использования Ragdocs?

Какая инфраструктура требуется для запуска Ragdocs?

Комментарии