Skip to content

Commit d2f1dd1

Browse files
committed
add pipx examples
1 parent aca60ba commit d2f1dd1

File tree

1 file changed

+48
-5
lines changed

1 file changed

+48
-5
lines changed

README.md

Lines changed: 48 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,19 @@
22

33
[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.
44

5-
## Installation
5+
## Usage
6+
7+
### Via pip
68

79
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.
810

911
```bash
1012
pip install ydb-mcp
1113
```
1214

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.
1416

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
1618

1719
```json
1820
{
@@ -28,7 +30,7 @@ To get started with YDB MCP, you'll need to configure your MCP client to communi
2830
}
2931
```
3032

31-
### Example: Using login/password authentication
33+
#### Example: Using Login/Password Authentication
3234

3335
To use login/password authentication, specify the `--ydb-auth-mode`, `--ydb-login`, and `--ydb-password` arguments:
3436

@@ -49,7 +51,48 @@ To use login/password authentication, specify the `--ydb-auth-mode`, `--ydb-logi
4951
}
5052
```
5153

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
5396

5497
YDB MCP provides the following tools for interacting with YDB databases:
5598

0 commit comments

Comments
 (0)