yuque-mcp

yuque-mcp

yuqueMIT
167 звёзд23 форков
Yuque (语雀) — аналог Notion и Confluence, популярный в Китае и экосистеме Alibaba. Платформа для технической документации, вики проектов и корпоративных баз знаний. MCP-сервер yuque-mcp — официальный шлюз от команды Yuque. Он работает через протокол MCP (Model Context Protocol), который даёт AI-ассистентам прямой доступ к внешним инструментам и данным. Разработчики и DevOps-инженеры просто просят ассистента найти документ, и он сам читает нужную книгу или статью. Никакого копирования ссылок и переключения между вкладками. Ассистент получает доступ ко всей вашей базе знаний: личным заметкам, документации проектов, вики команды.
Ai-ml
Открыть на GitHub

Установка

npx -y yuque-mcp

Характеристики

Общее

  • СтатусСообщество
  • Разработчикyuque
  • ЛицензияMIT

Технологии

  • Языки
    TypeScript
  • Транспорт
    stdio

Описание

Возможности

  • Поиск документов по всей базе знаний: по названию и содержимому.
  • Чтение содержимого статей, спецификаций и заметок без переключения контекста.
  • Просмотр полной структуры знаний: группы, книги внутри групп, документы внутри книг.
  • Анализ содержимого документов — ассистент находит и выделяет нужные разделы.
  • Автоматическая настройка для популярных клиентов одной командой (npx yuque-mcp install). CLI сам находит конфигурационный файл для вашей ОС, не удаляя другие серверы.
  • Интерактивный мастер установки для пошаговой конфигурации в терминале.
  • Поддержка Claude Desktop, VS Code (Copilot), Cursor, Windsurf, Cline и других MCP-клиентов.
  • Безопасное подключение через персональный токен Yuque — пароль не требуется.
  • Открытый исходный код под лицензией MIT.

Как подключить

1. Получите токен

Перейдите в настройки разработчика Yuque и создайте персональный токен доступа.

2. Установите сервер

Запустите CLI-команду. Укажите ваш токен и название клиента (claude-desktop, cursor, vscode, windsurf и другие):

npx yuque-mcp install --token=ВАШ_ТОКЕН --client=cursor

Или используйте интерактивный мастер для настройки:

npx yuque-mcp setup

CLI сам найдёт конфигурационный файл для вашей ОС, добавит сервер, не удаляя другие, и сообщит об успехе.

3. Ручная настройка (альтернатива)

Добавьте сервер в конфигурацию вашего MCP-клиента. Пример для Claude Desktop:

{"mcpServers":{"yuque":{"command":"npx","args":["-y","yuque-mcp"],"env":{"YUQUE_PERSONAL_TOKEN":"ВАШ_ТОКЕН"}}}}

4. Перезапустите клиент

После перезагрузки ассистент сможет обращаться к вашей базе знаний.

Примеры запросов

  • «Найди в документации спецификацию API для сервиса платежей и покажи обязательные поля запроса.»
  • «Покажи список всех книг в группе "Архитектура". Выбери из них последнюю обновлённую и сделай её краткое содержание.»
  • «Прочитай документ "Правила ревью кода" и выпиши основные требования к пул-реквестам.»
  • «Проверь, есть ли в базе знаний инструкция по развёртыванию в Kubernetes, и если есть — покажи команды из неё.»

Технические детали

  • Язык разработки: TypeScript
  • Транспортный протокол: stdio
  • Лицензия: MIT — можно свободно использовать и модифицировать
  • Разработчик: Официальная команда Yuque
  • Совместимость: Все MCP-клиенты (Claude Desktop, VS Code Copilot, Cursor, Windsurf, Cline и другие)
  • Установка: через npx без глобальной установки (npx -y yuque-mcp)
  • Требования к среде: Node.js версии 18 и выше
  • Настройка аутентификации: через переменную окружения YUQUE_PERSONAL_TOKEN или аргумент --token

Поделиться