You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[Model Context Protocol server](https://modelcontextprotocol.io/) for [YDB](https://ydb.tech). It allows to work with YDB databases from any [LLM](https://en.wikipedia.org/wiki/Large_language_model) that supports MCP. This integration enables AI-powered database operations and natural language interactions with your YDB instances.
4
7
5
8
## Usage
6
9
7
-
### Via pip
8
-
9
-
YDB MCP can be installed using `pip`, [Python's package installer](https://pypi.org/project/pip/). The package is [available on PyPI](https://pypi.org/project/ydb-mcp/) and includes all necessary dependencies.
10
-
11
-
```bash
12
-
pip install ydb-mcp
13
-
```
10
+
### Via uvx
14
11
15
-
To get started with YDB MCP, you'll need to configure your MCP client to communicate with the YDB instance. Below are example configuration files that you can customize according to your setup and then put into MCP client's settings. Path to the Python interpreter might also need to be adjusted to the correct virtual environment that has the `ydb-mcp` package installed.
12
+
[uvx](https://docs.astral.sh/uv/concepts/tools/), which is an allias for `uv run tool`, allows you to run various python applications without explicitly installing them. Below are examples of how to configure YDB MCP using `uvx`.
16
13
17
14
#### Example: Using Anonymous Authentication
18
15
19
16
```json
20
17
{
21
18
"mcpServers": {
22
19
"ydb": {
23
-
"command": "python3",
20
+
"command": "uvx",
24
21
"args": [
25
-
"-m", "ydb_mcp",
22
+
"ydb-mcp",
26
23
"--ydb-endpoint", "grpc://localhost:2136/local"
27
24
]
28
25
}
@@ -38,9 +35,9 @@ To use login/password authentication, specify the `--ydb-auth-mode`, `--ydb-logi
38
35
{
39
36
"mcpServers": {
40
37
"ydb": {
41
-
"command": "python3",
38
+
"command": "uvx",
42
39
"args": [
43
-
"-m", "ydb_mcp",
40
+
"ydb-mcp",
44
41
"--ydb-endpoint", "grpc://localhost:2136/local",
45
42
"--ydb-auth-mode", "login-password",
46
43
"--ydb-login", "<your-username>",
@@ -92,6 +89,53 @@ To use login/password authentication, specify the `--ydb-auth-mode`, `--ydb-logi
92
89
}
93
90
```
94
91
92
+
### Via pip
93
+
94
+
YDB MCP can be installed using `pip`, [Python's package installer](https://pypi.org/project/pip/). The package is [available on PyPI](https://pypi.org/project/ydb-mcp/) and includes all necessary dependencies.
95
+
96
+
```bash
97
+
pip install ydb-mcp
98
+
```
99
+
100
+
To get started with YDB MCP, you'll need to configure your MCP client to communicate with the YDB instance. Below are example configuration files that you can customize according to your setup and then put into MCP client's settings. Path to the Python interpreter might also need to be adjusted to the correct virtual environment that has the `ydb-mcp` package installed.
101
+
102
+
#### Example: Using Anonymous Authentication
103
+
104
+
```json
105
+
{
106
+
"mcpServers": {
107
+
"ydb": {
108
+
"command": "python3",
109
+
"args": [
110
+
"-m", "ydb_mcp",
111
+
"--ydb-endpoint", "grpc://localhost:2136/local"
112
+
]
113
+
}
114
+
}
115
+
}
116
+
```
117
+
118
+
#### Example: Using Login/Password Authentication
119
+
120
+
To use login/password authentication, specify the `--ydb-auth-mode`, `--ydb-login`, and `--ydb-password` arguments:
121
+
122
+
```json
123
+
{
124
+
"mcpServers": {
125
+
"ydb": {
126
+
"command": "python3",
127
+
"args": [
128
+
"-m", "ydb_mcp",
129
+
"--ydb-endpoint", "grpc://localhost:2136/local",
130
+
"--ydb-auth-mode", "login-password",
131
+
"--ydb-login", "<your-username>",
132
+
"--ydb-password", "<your-password>"
133
+
]
134
+
}
135
+
}
136
+
}
137
+
```
138
+
95
139
## Available Tools
96
140
97
141
YDB MCP provides the following tools for interacting with YDB databases:
0 commit comments