Ref MCP

Ref MCP

Ref MCP — это сервер Протокола Модели Контекста (MCP), предназначенный для предоставления ИИ-агентам и инструментам программирования эффективного и актуального доступа к технической документации для API, библиотек и сервисов. Он позволяет точно и экономно извлекать контекст документации для улучшения понимания кода и автоматизации.

Author: ref-tools


Просмотреть протокол

Что такое Ref MCP?

Ref MCP — это специализированный сервер MCP, который соединяет программные агенты и инструменты разработчиков с курируемой вселенной технической документации. Он дает возможность агентам искать, извлекать и анализировать наиболее актуальные части документации по запросу, минимизируя использование токенов и улучшая производительность LLM при работе с API и библиотеками.

Как настроить Ref MCP

Существует два основных способа настроить Ref MCP как сервер MCP:

1. HTTP потоковый (рекомендуется):

  • Установите Ref MCP через поддерживаемые клиенты (такие как Cursor) по предоставленным ссылкам на установку или указав конфигурацию сервера напрямую: 
    "Ref": {
  "type": "http",
  "url": "https://api.ref.tools/mcp?apiKey=YOUR_API_KEY"
}
  • Вам нужно зарегистрироваться на ref.tools, чтобы получить API-ключ.

2. Локальный stdio сервер (устаревший):

"Ref": {
  "command": "npx",
  "args": ["ref-tools-mcp@latest"],
  "env": {
    "REF_API_KEY": <your_api_key>
  }
}
  • Требуется Node.js и npm.

При желании, для локальной разработки и отладки, вы можете клонировать репозиторий Ref MCP, установить зависимости с помощью npm install и запустить с помощью npm run dev.

Как использовать Ref MCP

  1. Подключите вашего агента или инструмент, поддерживающий MCP, к серверу Ref MCP, используя описанную выше конфигурацию.
  2. Используйте доступные инструменты, такие как ref_search_documentation для поиска документации API, или ref_read_url для получения и уточнения соответствующего контента документации.
  3. Агенты могут выполнять итеративный поиск и чтение, умно сокращая контекст до необходимого для генерации кода или понимания.
  4. Для интеграций OpenAI Ref MCP автоматически сопоставляет свои инструменты с совместимыми именами функций OpenAI.

Для разработки и инспекции используйте MCP Inspector для визуального тестирования и мониторинга взаимодействий.

Основные функции

  • Экономное извлечение документации: Возвращает только наиболее актуальные части контекста, избегая избыточных затрат токенов и ухудшения производительности.
  • Итеративный, дружелюбный к агентам поиск: Адаптирует результаты поиска в течение сессии, никогда не повторяя результаты для похожих запросов.
  • Обогащение контекста по запросу: Позволяет LLM получать документацию точно тогда и там, где это необходимо.
  • Поддержка как публичных, так и частных источников: Поиск по публичной документации, веб-страницам, GitHub и частным ресурсам, таким как внутренние репозитории или PDF.
  • Интегрированное управление сессиями: Отслеживает траекторию поиска и чтения в пределах одной сессии агента для оптимизации курирования контекста.
  • Совместимость с OpenAI: Автоматически адаптирует названия инструментов для бесшовного использования с исследовательскими и программными агентами OpenAI.

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

  • ИИ-ассистенты кода: Увеличьте возможности программных агентов (таких как Claude Desktop или Cursor) с помощью точного доступа к технической документации.
  • Автоматизированная интеграция API: Помогите агентам понять, реализовать и устранять неполадки API, предоставляя наиболее актуальную документацию.
  • Боты для проверки кода и аудита: Оснастите агентов возможностью извлекать и цитировать авторитетные документы во время проверки кода.
  • Инструменты для адаптации разработчиков: Динамически отвечайте на распространенные вопросы разработчиков, ищя и извлекая информацию из корпоративной или публичной документации.
  • Глубокие технические исследования: Эффективно запрашивайте несколько источников и сосредоточьтесь на минимально возможном наборе контекста для точных ответов.

Часто задаваемые вопросы

Q1: Почему важно минимизировать токены в контексте документации?
A1: LLM обычно хуже справляются с большими, шумными окнами контекста, и токены стоят денег. Извлекая только актуальные части документации, Ref MCP улучшает производительность LLM и снижает ненужные затраты API.

Q2: Какую документацию может искать Ref MCP?
A2: Ref MCP ищет широкий спектр публичной документации (API, библиотеки, веб-документы) и может индексировать частные/внутренние ресурсы, включая репозитории GitHub и PDF.

Q3: Как Ref MCP гарантирует, что агенты LLM не читают один и тот же контент повторно?
A3: В активной сессии Ref MCP отслеживает предыдущие поиски и возвращенные результаты, гарантируя, что каждый похожий поиск приносит новые, не дублирующие документы, что способствует эффективному инжинирингу подсказок.

Q4: Могу ли я использовать Ref MCP с моим собственным агентом или инструментом?
A4: Да, любой агент или приложение, поддерживающее протокол MCP, может подключаться к Ref MCP как по HTTP, так и по стандартному потоку.

Q5: В чем разница между ref_search_documentation и ref_read_url?
A5: ref_search_documentation находит ссылки на актуальную документацию и контекст по запросу; ref_read_url извлекает и преобразует целевую страницу в маркдаун-сводку для удобства потребления агентом.