YDB MCP

YDB MCP

YDB 용 모델 컨텍스트 프로토콜 서버입니다 . MCP를 지원하는 모든 LLM 에서 YDB 데이터베이스와 연동할 수 있습니다. 이 통합을 통해 AI 기반 데이터베이스 운영 및 YDB 인스턴스와의 자연어 상호작용이 가능해집니다.

용법

uvx를 통해

uvx 는 uv run tool 의 별칭으로, 다양한 파이썬 애플리케이션을 명시적으로 설치하지 않고도 실행할 수 있도록 해줍니다. 아래는 uvx 사용하여 YDB MCP를 구성하는 방법의 예입니다.

예: 익명 인증 사용

지엑스피1

예: 로그인/비밀번호 인증 사용

로그인/비밀번호 인증을 사용하려면 --ydb-auth-mode , --ydb-login 및 --ydb-password 인수를 지정하세요.

pipx를 통해

pipx를 사용하면 PyPI에서 다양한 애플리케이션을 각각 명시적으로 설치하지 않고도 실행할 수 있습니다. 하지만 먼저 설치 해야 합니다. 아래는 pipx 사용하여 YDB MCP를 구성하는 방법의 예입니다.

예: 익명 인증 사용

예: 로그인/비밀번호 인증 사용

로그인/비밀번호 인증을 사용하려면 --ydb-auth-mode , --ydb-login 및 --ydb-password 인수를 지정하세요.

pip를 통해

YDB MCP는 Python 패키지 설치 프로그램 인 pip 사용하여 설치할 수 있습니다. 이 패키지는 PyPI에서 다운로드할 수 있으며 모든 필수 종속성을 포함하고 있습니다.

YDB MCP를 시작하려면 MCP 클라이언트가 YDB 인스턴스와 통신하도록 구성해야 합니다. 아래는 설정에 맞게 사용자 정의하여 MCP 클라이언트 설정에 적용할 수 있는 구성 파일 예시입니다. Python 인터프리터 경로도 ydb-mcp 패키지가 설치된 올바른 가상 환경에 맞게 조정해야 할 수 있습니다.

예: 익명 인증 사용

예: 로그인/비밀번호 인증 사용

로그인/비밀번호 인증을 사용하려면 --ydb-auth-mode , --ydb-login 및 --ydb-password 인수를 지정하세요.

사용 가능한 도구

YDB MCP는 YDB 데이터베이스와 상호 작용하기 위한 다음과 같은 도구를 제공합니다.

• ydb_query : YDB 데이터베이스에 대해 SQL 쿼리를 실행합니다.
  • 매개변수:
    • sql : 실행할 SQL 쿼리 문자열
• ydb_query_with_params : JSON 매개변수를 사용하여 매개변수화된 SQL 쿼리를 실행합니다.
  • 매개변수:
    • sql : 매개변수 자리 표시자가 있는 SQL 쿼리 문자열
    • params : 매개변수 값을 포함하는 JSON 문자열
• ydb_list_directory : YDB의 디렉토리 내용을 나열합니다.
  • 매개변수:
    • path : YDB 디렉토리 경로 목록
• ydb_describe_path : YDB 경로(테이블, 디렉토리 등)에 대한 자세한 정보를 가져옵니다.
  • 매개변수:
    • path : 설명할 YDB 경로
• ydb_status : YDB 연결의 현재 상태를 가져옵니다.

개발

이 프로젝트는 Make를 기본 개발 도구로 사용하여 일반적인 개발 작업에 대한 일관된 인터페이스를 제공합니다.

사용 가능한 Make 명령

이 프로젝트에는 개발 작업을 위한 다양한 명령어가 포함된 포괄적인 Makefile이 포함되어 있습니다. 각 명령어는 개발 워크플로우를 간소화하고 코드 품질을 보장하도록 설계되었습니다.

• make all : clean, lint, test를 순서대로 실행합니다(기본 대상)
• 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 : black과 isort를 사용하여 코드 포맷하기
• make install : 개발 모드로 패키지를 설치합니다.
• make dev : 모든 개발 종속성을 사용하여 개발 모드로 패키지를 설치합니다.

자세한 내용 제어 테스트

기본적으로 테스트는 출력을 깔끔하게 유지하기 위해 최소 출력(WARNING 레벨)으로 실행됩니다. LOG_LEVEL 환경 변수를 사용하여 테스트 출력의 상세 수준을 제어할 수 있습니다.

사용 가능한 로그 수준:

• DEBUG : 모든 디버그 메시지를 표시하여 자세한 테스트 흐름에 유용합니다.
• INFO : 정보 메시지 이상 표시
• WARNING : 경고 및 오류만 표시(기본값)
• ERROR : 오류 메시지만 표시합니다.