使用说明
MCP сервер для документации
MCP сервер для автоматизации работы с документацией, который позволяет создавать, анализировать и редактировать документацию с использованием протокола Model Context Protocol.
Возможности
Работа с топиками
- Создание новых топиков документации
- Обновление существующих топиков
- Поиск топиков по ключевым словам и тегам
Анализ и структура
- Анализ структуры документации (TOC) для нахождения оптимального места для топика
- Генерация черновиков документации на основе существующих топиков
- Анализ PRD/GTM документов для выделения структуры и содержимого
Стиль
- Проверка соответствия стайл-гайду
- Выявление проблем в стиле написания
- Рекомендации по улучшению стиля
Установка
# Клонировать репозиторий
git clone <repository-url>
# Перейти в директорию проекта
cd docs
# Установить зависимости
npm install
Разработка
# Компиляция TypeScript
npm run build
# Запуск сервера
npm start
# Разработка с автоматической перезагрузкой
npm run dev
Использование с Claude
Пример команды для анализа документа
@mcp
Проанализируй этот документ и создай из него структурированную документацию:
# Описание новой фичи X
## Функциональность
Фича X предоставляет пользователям возможность делать Y.
## Технические аспекты
Реализовано с использованием технологии Z.
Пример команды для проверки стиля
@mcp
Проверь стиль этого документа на соответствие стайл-гайду и предложи улучшения:
# Руководство
Пользователи могут кликать на кнопку для выполнения операции. Девайс при этом должен быть подключен к сети. В случае возникновения бага следует перезагрузить страницу.
Архитектура
Сервер построен на основе Model Context Protocol (MCP) и включает следующие компоненты:
- Основной MCP сервер - Обрабатывает запросы и управляет ресурсами и инструментами
- DocumentService - Управление топиками и структурой документации
- AnalysisService - Анализ контента и структуры
- StyleService - Проверка стиля и соответствия требованиям
Дальнейшее развитие
- Интеграция с Jira для создания задач
- Улучшенный анализ с использованием LLM
- Поддержка версионирования документации
- Экспорт в различные форматы (PDF, HTML, Wiki)
Лицензия
MIT
