Skip to content

Fix readme instructions #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 29, 2025
Merged

Fix readme instructions #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
"command": "uvx",
"args": [
"ydb-mcp",
"--ydb-endpoint", "grpc://localhost:2136/local"
"--ydb-endpoint", "grpc://localhost:2136",
"--ydb-database", "/local"
]
}
}
Expand All @@ -44,7 +45,8 @@
"command": "pipx",
"args": [
"run", "ydb-mcp",
"--ydb-endpoint", "grpc://localhost:2136/local"
"--ydb-endpoint", "grpc://localhost:2136",
"--ydb-database", "/local"
]
}
}
Expand All @@ -70,7 +72,8 @@ To get started with YDB MCP, you'll need to configure your MCP client to communi
"command": "python3",
"args": [
"-m", "ydb_mcp",
"--ydb-endpoint", "grpc://localhost:2136/local"
"--ydb-endpoint", "grpc://localhost:2136",
"--ydb-database", "/local"
]
}
}
Expand All @@ -92,7 +95,8 @@ To use login/password authentication, specify the `--ydb-auth-mode`, `--ydb-logi
"command": "uvx",
"args": [
"ydb-mcp",
"--ydb-endpoint", "grpc://localhost:2136/local",
"--ydb-endpoint", "grpc://localhost:2136",
"--ydb-database", "/local",
"--ydb-auth-mode", "login-password",
"--ydb-login", "<your-username>",
"--ydb-password", "<your-password>"
Expand All @@ -113,7 +117,8 @@ To use access token authentication, specify the `--ydb-auth-mode` and `--ydb-acc
"command": "uvx",
"args": [
"ydb-mcp",
"--ydb-endpoint", "grpc://localhost:2136/local",
"--ydb-endpoint", "grpc://localhost:2136",
"--ydb-database", "/local",
"--ydb-auth-mode", "access-token",
"--ydb-access-token", "qwerty123"
]
Expand All @@ -133,7 +138,8 @@ To use service account authentication, specify the `--ydb-auth-mode` and `--ydb-
"command": "uvx",
"args": [
"ydb-mcp",
"--ydb-endpoint", "grpc://localhost:2136/local",
"--ydb-endpoint", "grpc://localhost:2136",
"--ydb-database", "/local",
"--ydb-auth-mode", "service-account",
"--ydb-sa-key-file", "~/sa_key.json"
]
Expand Down
7 changes: 6 additions & 1 deletion ydb_mcp/server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1003,7 +1003,12 @@ def get_credentials_factory(self) -> Optional[Callable[[], ydb.Credentials]]:
# Clear any previous auth errors
self.auth_error = None

supported_auth_modes = {AUTH_MODE_ANONYMOUS, AUTH_MODE_LOGIN_PASSWORD}
supported_auth_modes = {
AUTH_MODE_ANONYMOUS,
AUTH_MODE_LOGIN_PASSWORD,
AUTH_MODE_SERVICE_ACCOUNT,
AUTH_MODE_ACCESS_TOKEN,
}
if self.auth_mode not in supported_auth_modes:
self.auth_error = (
f"Unsupported auth mode: {self.auth_mode}. Supported modes: {', '.join(supported_auth_modes)}"
Expand Down