概要
What is YDB MCP?
YDB MCP is a Model Context Protocol server for YDB, a distributed SQL database. It allows large language models (LLMs) that support MCP to interact with YDB databases through natural language, enabling AI-powered database operations.
How to use YDB MCP?
Install YDB MCP via uvx, pipx, or pip. Configure your MCP client with the server command and connection arguments (e.g., --ydb-endpoint, --ydb-database). Authentication can be anonymous, login/password, access token, or service account (requires the yandexcloud package for the latter). Examples for each method are provided in the README.
Key features of YDB MCP
- Run SQL queries against any YDB database
- Execute parameterized SQL queries with JSON parameters
- Explain query execution plans
- List directory contents and describe paths in YDB
- Check the current status of the YDB connection
- Supports building custom MCP servers by subclassing
YDBMCPServer
Use cases of YDB MCP
- Let an LLM explore and query a YDB database using natural language
- Implement read-only, domain-specific database tools for an AI assistant
- Build custom MCP servers that expose only the queries your application needs
- Diagnose YDB performance by explaining query plans via AI
FAQ from YDB MCP
What authentication modes does YDB MCP support?
Anonymous (default), login/password, access token, and service account authentication. Service account requires the yandexcloud package installed separately.
What tools are included with YDB MCP?
Seven tools: ydb_query, ydb_query_with_params, ydb_explain_query, ydb_explain_query_with_params, ydb_list_directory, ydb_describe_path, and ydb_status.
Can I restrict which tools the LLM can access?
Yes. When building a custom server by subclassing YDBMCPServer, you can set the generic_tools class attribute to a subset of YDBGenericTool values or an empty set to disable all built-in tools.
What are the runtime dependencies for YDB MCP?
YDB MCP is a Python package available on PyPI. It depends on the MCP SDK and YDB client libraries. For service account authentication, the yandexcloud package is also required.
How do I configure YDB MCP for my client?
Provide the server command (uvx ydb-mcp, pipx run ydb-mcp, or python -m ydb_mcp) and arguments such as --ydb-endpoint and --ydb-database. Authentication arguments can be added as needed.
