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 數據庫交互：

• 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 作為主要開發工具，提供一致的接口以簡化常見開發任務。

示例 Makefile

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

all: clean test

clean:
    # 除所有構建 artifacts 和臨時文件
    -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

測試輸出控制

默認情況下，測試運行時輸出 verbosity 為 WARNING 級別。您可以通過設置 LOG_LEVEL 環境變量來控制測試輸出的詳細程度：

# 以調試模式運行所有測試
make test LOG_LEVEL=DEBUG

# 以信息模式運行集成測試
make integration-tests LOG_LEVEL=INFO

# 以默認警告模式運行單元測試（默認）
make unit-tests LOG_LEVEL=WARNING

支持的輸出級別：

• DEBUG：顯示所有調試消息，適用於詳細測試流程
• INFO：顯示 informational 消息及更高級別
• WARNING：默認設置，僅顯示警告和錯誤
• ERROR：僅顯示錯誤消息

📄 許可證

本項目採用 Apache 2.0 許可證。