Skip to content

Commit 322ef2f

Browse files
committed
Add docs about uvx and bagdes
1 parent a975550 commit 322ef2f

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# YDB MCP
2+
---
3+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/ydb-platform/ydb-mcp/blob/main/LICENSE)
4+
[![PyPI version](https://badge.fury.io/py/ydb-mcp.svg)](https://badge.fury.io/py/ydb-mcp)
25

36
[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.
47

@@ -92,6 +95,47 @@ To use login/password authentication, specify the `--ydb-auth-mode`, `--ydb-logi
9295
}
9396
```
9497

98+
### Via uvx
99+
100+
[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`.
101+
102+
#### Example: Using Anonymous Authentication
103+
104+
```json
105+
{
106+
"mcpServers": {
107+
"ydb": {
108+
"command": "uvx",
109+
"args": [
110+
"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": "uvx",
127+
"args": [
128+
"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+
95139
## Available Tools
96140

97141
YDB MCP provides the following tools for interacting with YDB databases:

0 commit comments

Comments
 (0)