YDB MCP

YDB МКП

Сервер протокола контекста модели для YDB . Позволяет работать с базами данных YDB из любого LLM , поддерживающего MCP. Эта интеграция позволяет выполнять операции с базами данных на базе ИИ и взаимодействовать с вашими экземплярами YDB на естественном языке.

Использование

Через uvx

uvx , который является аналогом uv run tool , позволяет запускать различные приложения Python без их явной установки. Ниже приведены примеры того, как настроить YDB MCP с помощью uvx .

Пример: использование анонимной аутентификации

Пример: использование аутентификации по логину/паролю

Чтобы использовать аутентификацию по имени пользователя и паролю, укажите аргументы --ydb-auth-mode , --ydb-login и --ydb-password :

Через pipx

pipx позволяет запускать различные приложения из PyPI без явной установки каждого из них. Однако сначала его необходимо установить . Ниже приведены примеры того, как настроить YDB MCP с помощью pipx .

Пример: использование анонимной аутентификации

Пример: использование аутентификации по логину/паролю

Чтобы использовать аутентификацию по имени пользователя и паролю, укажите аргументы --ydb-auth-mode , --ydb-login и --ydb-password :

Через пип

YDB MCP можно установить с помощью pip , установщика пакетов Python . Пакет доступен на PyPI и включает все необходимые зависимости.

Чтобы начать работу с YDB MCP, вам нужно настроить клиент MCP для связи с экземпляром YDB. Ниже приведены примеры файлов конфигурации, которые вы можете настроить в соответствии с вашей настройкой, а затем добавить в настройки клиента MCP. Путь к интерпретатору Python также может потребоваться настроить на правильную виртуальную среду, в которой установлен пакет ydb-mcp .

Пример: использование анонимной аутентификации

Пример: использование аутентификации по логину/паролю

Чтобы использовать аутентификацию по имени пользователя и паролю, укажите аргументы --ydb-auth-mode , --ydb-login и --ydb-password :

Доступные инструменты

YDB MCP предоставляет следующие инструменты для взаимодействия с базами данных YDB:

• ydb_query : Выполнение SQL-запроса к базе данных YDB
  • Параметры:
    • sql : строка SQL-запроса для выполнения
• ydb_query_with_params : запуск параметризованного SQL-запроса с параметрами JSON
  • Параметры:
    • sql : строка запроса SQL с заполнителями параметров
    • params : строка JSON, содержащая значения параметров
• ydb_list_directory : Список содержимого каталога в YDB
  • Параметры:
    • path : путь к каталогу YDB для списка
• ydb_describe_path : Получить подробную информацию о пути YDB (таблица, каталог и т. д.)
  • Параметры:
    • path : путь YDB для описания
• ydb_status : Получить текущий статус соединения YDB

Разработка

В качестве основного инструмента разработки проект использует Make , предоставляя единый интерфейс для выполнения общих задач разработки.

Доступные команды создания

Проект включает в себя комплексный Makefile с различными командами для задач разработки. Каждая команда предназначена для оптимизации рабочего процесса разработки и обеспечения качества кода:

• make all : последовательно запустить очистку, линтинг и тестирование (цель по умолчанию)
• make clean : удалить все артефакты сборки и временные файлы
• make test : запустить все тесты с помощью pytest
  • Можно настроить с помощью переменных среды:
    • LOG_LEVEL (по умолчанию: WARNING) — контроль детализации выходных данных теста (DEBUG, INFO, WARNING, ERROR)
• make unit-tests : Запускать только модульные тесты с подробным выводом
  • Можно настроить с помощью переменных среды:
    • LOG_LEVEL (по умолчанию: WARNING) — контроль детализации выходных данных теста (DEBUG, INFO, WARNING, ERROR)
• make integration-tests : Запускать только интеграционные тесты с подробным выводом
  • Можно настроить с помощью переменных среды:
    • YDB_ENDPOINT (по умолчанию: grpc://localhost:2136)
    • YDB_DATABASE (по умолчанию: /local)
    • MCP_HOST (по умолчанию: 127.0.0.1)
    • MCP_PORT (по умолчанию: 8989)
    • LOG_LEVEL (по умолчанию: WARNING) — контроль детализации выходных данных теста (DEBUG, INFO, WARNING, ERROR)
• make run-server : запуск сервера YDB MCP
  • Можно настроить с помощью переменных среды:
    • YDB_ENDPOINT (по умолчанию: grpc://localhost:2136)
    • YDB_DATABASE (по умолчанию: /local)
  • Дополнительные аргументы можно передать с помощью ARGS="your args"
• make lint : выполнить все проверки линтинга (flake8, mypy, black, isort)
• make format : Форматирование кода с использованием черного и isort
• make install : Установить пакет в режиме разработки
• make dev : установить пакет в режиме разработки со всеми зависимостями разработки

Контроль детализации теста

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

Доступные уровни журнала:

• DEBUG : показать все отладочные сообщения, полезно для подробного потока тестирования.
• INFO : Показывать информационные сообщения и выше
• WARNING : Показывать только предупреждения и ошибки (по умолчанию)
• ERROR : Показывать только сообщения об ошибках