This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Быстрый старт

Добро пожаловать в документацию по MinerU MCP Server. Эта страница поможет вам быстро развернуть сервер для интеграции с LLM-агентами.

Назначение

MinerU MCP Server — это микросервис, который предоставляет LLM-агентам возможность извлекать текст и структурированные данные из документов (PDF, изображения, DOCX, PPTX, XLSX) через стандартизированный протокол MCP. Подробнее о назначении и возможностях читайте в разделе Обзор проекта.

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

• Docker и Docker Compose
• Self-hosted экземпляр MinerU (или доступ к нему по сети)
• (Опционально) Python 3.11+ для локальной разработки без Docker

1. Клонирование репозитория

Выполните следующие команды для загрузки исходного кода:

git clone https://git.maydayoffice.kz/maydayoffice/mineru-mcp-server.git
cd mineru-mcp-server

2. Настройка переменных окружения

Сервер настраивается через переменные окружения, которые задаются в файле docker-compose.yml.

Откройте файл и отредактируйте секцию environment для сервиса mineru-mcp:

environment:
  # Адрес вашего экземпляра MinerU
  - MINERU_URL=http://mineru:8000
  # Бэкенд парсинга (pipeline, vlm-engine, hybrid-engine и др.)
  - MINERU_BACKEND=hybrid-engine
  # Языки для OCR (cyrillic, east_slavic, ch, korean и др.)
  - MINERU_LANG_LIST=cyrillic
  # Таймаут ожидания задачи в секундах (по умолчанию 600)
  - MCP_TIMEOUT_SECONDS=600
  # Интервал опроса статуса задачи в секундах (по умолчанию 5)
  - MCP_POLL_INTERVAL_SECONDS=5
  # Порт MCP-сервера
  - MCP_PORT=8001
  # Уровень детализации (medium, high)
  - DEFAULT_EFFORT=medium
  # Уровень логирования (DEBUG, INFO, WARNING, ERROR)
  - LOG_LEVEL=INFO
  # Ключ API для защиты (опционально, раскомментируйте для включения)
  # - MCP_API_KEY=your-super-secret-api-key-12345

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

3. Запуск через Docker Compose

Запустите сборку и поднятие контейнеров одной командой:

docker-compose up -d

Чтобы просмотреть логи работы сервера:

docker-compose logs -f mineru-mcp

После успешного запуска MCP-сервер будет доступен по адресу: http://localhost:8001/mcp.

Дальнейшие шаги

1. Проверка работоспособности: Узнайте, как протестировать сервер вручную через curl или с помощью встроенных тестов в разделе Тестирование.
2. Интеграция с LLM: Настройте LiteLLM как шлюз для вашего MCP-сервера, следуя инструкции в разделе Интеграция с LiteLLM.
3. Использование API: Изучите параметры инструмента parse_document и структуру ответов в разделе Документация API.
4. Понимание работы: Ознакомьтесь с тем, как данные передаются между компонентами, в разделе Архитектура.

Если возникнут проблемы, обратитесь к разделу Устранение неполадок.