GitMCP

GitMCP

🤔 Что такое GitMCP?

Перестаньте галлюцинировать и начните кодировать вибрации!

GitMCP — это бесплатный сервер Model Context Protocol (MCP) с открытым исходным кодом, который преобразует любой проект GitHub (репозитории или страницы GitHub) в центр документации. Он позволяет инструментам ИИ, таким как Cursor, получать доступ к актуальной документации и коду, даже если LLM никогда с ними не сталкивался, тем самым без проблем устраняя галлюцинации кода.

GitMCP поддерживает две версии :

• Конкретный репозиторий ( gitmcp.io/{owner}/{repo} или {owner}.gitmcp.io/{repo} ): используйте их, когда вы в основном работаете с определенным количеством библиотек. Это гарантирует, что ваш помощник ИИ всегда будет нацелен на правильный проект, что повышает безопасность и релевантность, предотвращая доступ к непреднамеренным репозиториям.
• Generic Server ( gitmcp.io/docs ): используйте это для максимальной гибкости, когда вам нужно часто переключаться между разными репозиториями. Помощник ИИ подскажет вам (или решит на основе контекста), к какому репозиторию обращаться для каждого запроса. Помните, что это зависит от правильного определения целевого репозитория каждый раз.

С GitMCP:

• Помощники на основе искусственного интеллекта получают доступ к новейшей документации и коду непосредственно из источника.
• Получите точные данные об использовании API и надежные примеры кода.
• Эффективно работайте даже с узкоспециализированными, новыми или быстро меняющимися библиотеками.
• Значительно уменьшено количество галлюцинаций и улучшена корректность кода.

Например, это параллельное сравнение показывает результат для одного и того же однократного запроса в Cursor при создании сцены three.js -

https://github.com/user-attachments/assets/fbf1b4a7-f9f0-4c0e-831c-4d64faae2c45

✨ Особенности

• 😎 Последняя документация по ЛЮБОМУ проекту GitHub : предоставьте вашему помощнику ИИ беспрепятственный доступ к документации и коду проекта GitHub. Встроенные возможности интеллектуального поиска помогают найти именно то, что нужно ИИ, не используя слишком много токенов!
• 🧠 Больше никаких галлюцинаций : с GitMCP ваш помощник на основе искусственного интеллекта может давать точные и актуальные ответы на ваши вопросы.
• ☁️ Нулевая настройка : GitMCP работает в облаке. Просто добавьте выбранный URL-адрес GitMCP в качестве сервера MCP в вашей IDE — никаких загрузок, установок, регистраций или изменений не требуется.
• 💬 Встроенный чат : начните прямое общение с документацией репозитория через наш чат в браузере!
• ✅ Открытый, бесплатный и частный : GitMCP имеет открытый исходный код и полностью бесплатен в использовании. Он не собирает личную информацию и не хранит запросы. Вы даже можете разместить его у себя!

🚀 Начало работы

Использовать GitMCP легко! Просто выполните следующие шаги:

Шаг 1: Выберите желаемый тип сервера

Выберите один из этих форматов URL в зависимости от того, к чему вы хотите подключиться:

• Для репозиториев GitHub: gitmcp.io/{owner}/{repo}
• Для сайтов GitHub Pages: {owner}.gitmcp.io/{repo}
• Для универсального инструмента, который поддерживает любой репозиторий (динамический): gitmcp.io/docs

Замените {owner} на имя пользователя GitHub или название организации, а {repo} на имя репозитория.

Для вашего удобства вы также можете использовать инструмент конвертации на целевой странице, чтобы отформатировать URL-адрес GitHub в URL-адрес MCP!

Шаг 2: Подключите своего помощника на базе искусственного интеллекта

Выберите своего ИИ-помощника из предложенных ниже вариантов и следуйте инструкциям по настройке:

Соединительный курсор

Обновите файл конфигурации курсора по адресу ~/.cursor/mcp.json :

Подключение Claude Desktop

1. В Claude Desktop перейдите в Настройки > Разработчик > Изменить конфигурацию.
2. Замените конфигурацию на:
   { "mcpServers": { "gitmcp": { "command": "npx", "args": [ "mcp-remote", "https://gitmcp.io/{owner}/{repo}" ] } } }

Подключение виндсерфинга

Обновите файл конфигурации Windsurf по адресу ~/.codeium/windsurf/mcp_config.json :

Подключение VSCode

Обновите файл конфигурации VSCode по адресу .vscode/mcp.json :

Подключение Клайна

Обновите файл конфигурации Cline в ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json :

Подключение Highlight AI

1. Откройте Highlight AI и щелкните значок плагинов (символ @) на боковой панели.
2. Нажмите «Установленные плагины» в верхней части боковой панели.
3. Выберите пользовательский плагин
4. Нажмите « Добавить плагин», используя пользовательский URL-адрес SSE.

Имя плагина: gitmcp SSE URL: https://gitmcp.io/{owner}/{repo}

Более подробную информацию о добавлении пользовательских серверов MCP в HighlightAI можно найти в документации .

Примечание: Не забудьте заменить {owner} и {repo} на фактическое имя пользователя/организации GitHub и имя репозитория. Вы также можете использовать динамическую конечную точку https://gitmcp.io/docs , чтобы разрешить вашему ИИ доступ к любому репозиторию по требованию.

⚙ Как это работает

GitMCP подключает вашего ИИ-помощника к репозиториям GitHub с помощью протокола контекста модели (MCP) — стандарта, который позволяет инструментам ИИ запрашивать дополнительную информацию из внешних источников.

Что происходит при использовании GitMCP:

1. Вы предоставляете URL-адрес GitMCP вашему помощнику AI (например, gitmcp.io/microsoft/typescript ). GitMCP предоставляет такие инструменты, как получение документации, интеллектуальный поиск, поиск кода и т. д.
2. Задавайте вопросы ИИ-помощнику по документации/коду.
3. Ваш ИИ отправляет запросы в GitMCP на использование его инструментов (с вашего одобрения).
4. GitMCP выполняет запрос ИИ и возвращает запрошенные данные.
5. Ваш ИИ получает информацию и генерирует более точный, обоснованный ответ без галлюцинаций.

Поддерживаемая документация

В настоящее время GitMCP поддерживает следующие документы (в порядке приоритета):

1. llms.txt
2. Оптимизированная для ИИ версия документации проекта
3. README.md /root

💡 Примеры

Вот несколько примеров использования GitMCP с различными помощниками ИИ и репозиториями:

Пример 1: Использование Windsurf с определенным репозиторием

Для репозитория GitHub https://github.com/microsoft/playwright-mcp добавьте https://gitmcp.io/microsoft/playwright-mcp в качестве сервера MCP в Windsurf.

Подсказка Клоду:

«Как использовать MCP драматурга»

Windsurf извлечет соответствующую документацию из GitMCP для корректной реализации функции памяти.

Пример 2: использование курсора на сайте GitHub Pages

Для сайта GitHub Pages langchain-ai.github.io/langgraph добавьте https://langchain-ai.gitmcp.io/langgraph в качестве сервера MCP в Cursor.

Подсказка для курсора:

«Добавить память в мой агент LangGraph»

Курсор извлечет соответствующую документацию и код из GitMCP для корректной реализации функции памяти.

Пример 3: Использование Claude Desktop с динамической конечной точкой

Вам не нужно выбирать конкретные репозитории. Общая конечная точка gitmcp.io/docs позволяет ИИ выбирать проект GitHub на лету!

Дайте команду любому помощнику на основе искусственного интеллекта:

«Я хочу узнать о модели распознавания речи OpenAI Whisper. Объясните, как она работает.

Клод извлечет данные из GitMCP и ответит на вопрос.

🛠️ Инструменты

GitMCP предоставляет помощникам на базе искусственного интеллекта несколько ценных инструментов, помогающих им получать доступ к репозиториям GitHub, понимать их и выполнять запросы.

fetch_<repo-name>_documentation

Этот инструмент получает основную документацию из репозитория GitHub. Он работает, извлекая соответствующую документацию (например, llms.txt ). Это дает ИИ хорошее представление о том, что представляет собой проект

Когда это полезно: для общих вопросов о цели проекта, его особенностях или о том, как начать работу.

search_<repo-name>_documentation

Этот инструмент позволяет ИИ искать в документации репозитория, предоставляя определенный поисковый запрос. Вместо загрузки всей документации (которая может быть очень большой), он использует интеллектуальный поиск, чтобы найти только соответствующие части.

Когда это полезно: Для конкретных вопросов о конкретных функциях, особенностях или концепциях в рамках проекта.

fetch_url_content

Этот инструмент помогает ИИ получать информацию из ссылок, упомянутых в документации. Он извлекает содержимое из этих ссылок и преобразует его в формат, который ИИ может легко прочитать.

Когда это полезно: Когда документация ссылается на внешнюю информацию, которая может помочь ответить на ваш вопрос.

search_<repo-name>_code

Этот инструмент ищет в реальном коде в репозитории, используя поиск кода GitHub. Он помогает ИИ находить конкретные примеры кода или детали реализации.

Когда это полезно: Когда вам нужны примеры того, как что-то реализовано, или вам нужны технические подробности, не описанные в документации.

Примечание: при использовании динамической конечной точки ( gitmcp.io/docs ) эти инструменты называются немного по-другому ( fetch_generic_documentation , search_generic_code и search_generic_documentation ) и требуют дополнительной информации о том, к какому репозиторию обращаться.

📊 Значок

GitMCP имеет значок README вашего репозитория. Он позволяет пользователям быстро получать доступ к вашей документации через IDE или браузер (используя встроенный чат). Он также показывает, сколько раз к вашей документации обращались через GitMCP.

Пример ( idosal/git-mcp ):

Добавление значка в ваш репозиторий

Добавьте следующее в ваш README.md :

Замените OWNER на имя вашего пользователя или организации GitHub, а REPO на имя вашего репозитория.

Как мы считаем просмотры

Приращение для каждого вызова инструмента в конкретном репозитории.

Настройка значка

Вы можете настроить внешний вид значка с помощью параметров:

Пожалуйста, свяжитесь с нами!

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

Что такое протокол контекста модели?

Протокол контекста модели — это стандарт, который позволяет помощникам на основе ИИ запрашивать и получать дополнительный контекст из внешних источников в структурированном виде, что улучшает их понимание и производительность.

Работает ли GitMCP с какими-либо помощниками на основе искусственного интеллекта?

Да, GitMCP совместим с любым помощником на основе искусственного интеллекта, поддерживающим протокол контекста модели, включая такие инструменты, как Cursor, VSCode, Claude и т. д.

Совместим ли GitMCP со всеми проектами GitHub?

Конечно! GitMCP работает с любым публичным репозиторием GitHub, не требуя никаких изменений. Он отдает приоритет файлу llms.txt и возвращается к README.md или другим страницам, если первый недоступен. Будущие обновления нацелены на поддержку дополнительных методов документирования и даже динамическую генерацию контента.

Стоит ли GitMCP денег?

Нет, GitMCP — это бесплатная услуга для сообщества, не требующая никаких дополнительных затрат.

🔒 Конфиденциальность

GitMCP глубоко привержен конфиденциальности своих пользователей. Сервис не имеет доступа к персонально идентифицируемой информации и не хранит ее, поскольку не требует аутентификации. Кроме того, он не хранит запросы, отправленные агентами. Более того, поскольку GitMCP является проектом с открытым исходным кодом, его можно развернуть независимо в вашей среде.

GitMCP получает доступ только к контенту, который уже доступен публично, и только по запросу пользователя. GitMCP не выполняет автоматический скрейпинг репозиториев. Перед доступом к любому сайту GitHub Pages код проверяет правила robots.txt и следует директивам, установленным владельцами сайтов, что позволяет им отказаться. Обратите внимание, что GitMCP не хранит данные о проектах GitHub или их контенте постоянно.

👥 Вклад

Мы приветствуем вклады, отзывы и идеи! Ознакомьтесь с нашими правилами по вкладам .

Настройка локального развития

1. Клонировать репозиторий
   git clone https://github.com/idosal/git-mcp.git cd git-mcp
2. Установить зависимости
   pnpm install
3. Запустить локально для разработки
   npm run dev # or pnpm dev

Использование MCP Inspector для тестирования

1. Установите инструмент MCP Inspector:
   npx @modelcontextprotocol/inspector
2. В интерфейсе инспектора:
   • Установите тип транспорта на SSE
   • Введите URL-адрес вашего GitMCP (например, http://localhost:5173/docs )
   • Нажмите «Подключиться».

📄 Лицензия

Данный проект лицензирован по лицензии Apache License 2.0 .

Отказ от ответственности

GitMCP предоставляется «как есть» без каких-либо гарантий. Хотя мы стремимся обеспечить надежность и безопасность нашего сервиса, мы не несем ответственности за любые убытки или проблемы, которые могут возникнуть в результате его использования. Проекты GitHub, доступные через GitMCP, подчиняются положениям и условиям их владельцев. GitMCP не связан с GitHub или любым из упомянутых инструментов ИИ.

История Звезды