YDB

🚀 YDB MCP

YDBのModel Context Protocolサーバーです。これにより、MCPをサポートする任意のLLMからYDBデータベースを使用できます。この統合により、AIはデータベース操作を実行し、自然言語でYDBインスタンスと対話できます。

🚀 クイックスタート

💻 使用例

基本的な使用法

uvxを使用した起動方法について説明します。uvx は uv run tool のエイリアスで、Pythonアプリケーションを明示的にインストールすることなく実行できます。

サンプル設定ファイル (uv.json)

{
  "interpreter": {
    "name": "python",
    "version": "3"
  },
  "env": {},
  "configurations": [
    {
      "name": "MCPサーバーの起動",
      "type": "process",
      "request": "launch",
      "program": "${file}",
      "console": "integratedTerminal",
      "args": []
    }
  ]
}

高度な使用法

make コマンドを使用してテストを実行する方法です。ターミナルで以下のコマンドを入力すると、すべてのテストを実行できます。

make test

✨ 主な機能

YDB MCPは、YDBデータベースとの対話を容易にするための以下のツールを提供します。

🔧 技術詳細

開発ツール

このプロジェクトは、一般的な開発タスクを簡素化するための一貫したインターフェースを提供する Make を主要な開発ツールとして使用しています。

サンプルMakefile

.PHONY: all clean test unit-tests integration-tests run-server lint format install dev

all: clean test

clean:
    # すべてのビルドアーティファクトと一時ファイルを削除します。
    -rm -rf build/
    -rm -rf *.egg-info/

test:
    LOG_LEVEL?=WARNING
    pytest tests/ --log-level=$(LOG_LEVEL)

unit-tests:
    LOG_LEVEL?=WARNING
    pytest tests/unit/ --log-level=$(LOG_LEVEL) -v

integration-tests:
    YDB_ENDPOINT?=grpc://localhost:2136
    YDB_DATABASE?=local
    MCP_HOST?=127.0.0.1
    MCP_PORT?=8989
    pytest tests/integration/ --log-level=$(LOG_LEVEL) -v

run-server:
    YDB_ENDPOINT?=grpc://localhost:2136
    YDB_DATABASE?=local
    python -m ydb_mcp_server $(ARGS)

lint:
    flake8 .
    mypy .

format:
    black .
    isort .

install:
    pip install -e .

dev:
    pip install -e .[dev]

.DEFAULT_GOAL := all

テスト出力の制御

デフォルトでは、テスト実行時の出力詳細度はWARNINGレベルです。LOG_LEVEL 環境変数を設定することで、テスト出力の詳細度を制御できます。

# すべてのテストをデバッグモードで実行します。
make test LOG_LEVEL=DEBUG

# 統合テストを情報モードで実行します。
make integration-tests LOG_LEVEL=INFO

# 単体テストをデフォルトの警告モードで実行します（デフォルト）
make unit-tests LOG_LEVEL=WARNING

サポートされている出力レベル:

• DEBUG: すべてのデバッグメッセージを表示し、詳細なテストプロセスに適しています。
• INFO: 情報メッセージとそれ以上のレベルを表示します。
• WARNING: デフォルト設定で、警告とエラーのみを表示します。
• ERROR: エラーメッセージのみを表示します。

📄 ライセンス

このプロジェクトは Apache 2.0 ライセンスの下で公開されています。