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
Copy file name to clipboardExpand all lines: README.md
+48-5Lines changed: 48 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,17 +2,19 @@
2
2
3
3
[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
4
5
-
## Installation
5
+
## Usage
6
+
7
+
### Via pip
6
8
7
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.
8
10
9
11
```bash
10
12
pip install ydb-mcp
11
13
```
12
14
13
-
## Usage
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.
14
16
15
-
To get started with YDB MCP, you'll need to configure your MCP client to communicate with the YDB instance. Below is an example configuration file that you can customize according to your setup and then put into MCP client's settings.
17
+
#### Example: Using Anonymous Authentication
16
18
17
19
```json
18
20
{
@@ -28,7 +30,7 @@ To get started with YDB MCP, you'll need to configure your MCP client to communi
28
30
}
29
31
```
30
32
31
-
### Example: Using login/password authentication
33
+
####Example: Using Login/Password Authentication
32
34
33
35
To use login/password authentication, specify the `--ydb-auth-mode`, `--ydb-login`, and `--ydb-password` arguments:
34
36
@@ -49,7 +51,48 @@ To use login/password authentication, specify the `--ydb-auth-mode`, `--ydb-logi
49
51
}
50
52
```
51
53
52
-
## Available tools
54
+
### Via pipx
55
+
56
+
[pipx](https://pipx.pypa.io/stable/) allows you to run various applications from PyPI without explicitly installing each one. However, it must be [installed](https://pipx.pypa.io/stable/#install-pipx) first. Below are examples of how to configure YDB MCP using `pipx`.
57
+
58
+
#### Example: Using Anonymous Authentication
59
+
60
+
```json
61
+
{
62
+
"mcpServers": {
63
+
"ydb": {
64
+
"command": "pipx",
65
+
"args": [
66
+
"run", "ydb-mcp",
67
+
"--ydb-endpoint", "grpc://localhost:2136/local"
68
+
]
69
+
}
70
+
}
71
+
}
72
+
```
73
+
74
+
#### Example: Using Login/Password Authentication
75
+
76
+
To use login/password authentication, specify the `--ydb-auth-mode`, `--ydb-login`, and `--ydb-password` arguments:
77
+
78
+
```json
79
+
{
80
+
"mcpServers": {
81
+
"ydb": {
82
+
"command": "pipx",
83
+
"args": [
84
+
"run", "ydb-mcp",
85
+
"--ydb-endpoint", "grpc://localhost:2136/local",
86
+
"--ydb-auth-mode", "login-password",
87
+
"--ydb-login", "<your-username>",
88
+
"--ydb-password", "<your-password>"
89
+
]
90
+
}
91
+
}
92
+
}
93
+
```
94
+
95
+
## Available Tools
53
96
54
97
YDB MCP provides the following tools for interacting with YDB databases:
0 commit comments