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
Renamed at the request of DBeaver Corporation. The server still reads
connections from the same local DB client workspace (DBeaver-compatible),
only the branding changed.
BREAKING CHANGES:
- npm package: dbeaver-mcp-server → omnisql-mcp
- binary: dbeaver-mcp-server → omnisql-mcp
- env vars: DBEAVER_* → OMNISQL_* (e.g. DBEAVER_READ_ONLY → OMNISQL_READ_ONLY,
DBEAVER_PATH → OMNISQL_CLI_PATH)
- resource URI scheme: dbeaver:// → omnisql://
- internal classes: DBeaverMCPServer → OmniSQLMCPServer, DBeaverClient →
WorkspaceClient, DBeaverConfigParser → WorkspaceConfigParser
- interfaces: DBeaverConnection → DatabaseConnection, DBeaverConfig →
WorkspaceConfig
- removed CLI auto-detection; users must set OMNISQL_CLI_PATH explicitly
to use the unsupported-driver CLI fallback
Also fixes a broken CI step (npm install -g npm@latest was breaking npm
itself on the runner; Node 22's bundled npm already supports OIDC).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
-**Renamed environment variables**: All `DBEAVER_*` env vars are now `OMNISQL_*` (for example, the old `DBEAVER_READ_ONLY` is now `OMNISQL_READ_ONLY`, old `DBEAVER_WORKSPACE` is now `OMNISQL_WORKSPACE`, and old `DBEAVER_PATH` is now `OMNISQL_CLI_PATH`). Update your MCP client config.
14
+
-**Renamed resource URI scheme**: `dbeaver://` → `omnisql://` for table schema resources.
-**CLI auto-detection removed**: `OMNISQL_CLI_PATH` must now be set explicitly to use the CLI fallback for unsupported drivers. Previously the server attempted to locate the DB client binary in hardcoded install paths.
17
+
18
+
Functional behavior is otherwise unchanged — the server still reads connections from the same local DB client workspace (DBeaver-compatible).
19
+
8
20
## [1.3.0] - 2026-02-16
9
21
10
22
### Added
@@ -23,29 +35,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
23
35
24
36
### Changed
25
37
- CI workflow now includes a `publish` job that runs after all checks pass on `main`
26
-
- Pool manager's `isPostgresCompatible()` is now a public method shared with dbeaver-client
38
+
- Pool manager's `isPostgresCompatible()` is now a public method shared with workspace-client
27
39
28
40
## [1.2.5] - 2026-02-15
29
41
30
42
### Added
31
-
- Connection whitelist via `DBEAVER_ALLOWED_CONNECTIONS` environment variable — restrict which DBeaver connections are visible by ID or name
43
+
- Connection whitelist via `OMNISQL_ALLOWED_CONNECTIONS` environment variable — restrict which workspace connections are visible by ID or name
32
44
-`enforceReadOnly()` query-level enforcement — `execute_query` now strictly allows only read-only statements (SELECT, EXPLAIN, SHOW, DESCRIBE, PRAGMA)
33
45
- Test queries for SAP HANA (`SELECT * FROM DUMMY`) and DB2 (`SYSIBM.SYSDUMMY1`)
34
46
35
47
### Fixed
36
48
-**Read-only mode bypass (Issue #19)**: `execute_query` no longer allows write operations (INSERT/UPDATE/DELETE/CREATE/ALTER/DROP). Transaction tools (`begin_transaction`, `commit_transaction`, `rollback_transaction`, `execute_in_transaction`) are now blocked in read-only mode.
37
-
-**Unsupported driver errors (Issue #17)**: DBeaver CLI fallback now provides clear, actionable error messages listing natively supported drivers and workarounds. DBeaver availability is checked before attempting CLI fallback.
49
+
-**Unsupported driver errors (Issue #17)**: CLI fallback now provides clear, actionable error messages listing natively supported drivers and workarounds. CLI availability is checked before attempting fallback.
38
50
-**UPDATE validation regex**: `UPDATE ... SET ... WHERE ...` was incorrectly blocked by the dangerous query filter. The regex now correctly allows UPDATE with WHERE clause.
39
51
40
52
### Changed
41
-
-DBeaver CLI fallback uses connection name-based spec for better compatibility
53
+
- CLI fallback uses connection name-based spec for better compatibility
42
54
43
55
## [1.2.4] - 2026-01-15
44
56
45
57
### Added
46
58
- Native MySQL/MariaDB support via `mysql2` library
47
-
- Read-only mode (`DBEAVER_READ_ONLY=true`) to disable write operations
48
-
- Tool filtering via `DBEAVER_DISABLED_TOOLS` environment variable
59
+
- Read-only mode (`OMNISQL_READ_ONLY=true`) to disable write operations
60
+
- Tool filtering via `OMNISQL_DISABLED_TOOLS` environment variable
49
61
- GitHub Actions CI/CD pipeline
50
62
- ESLint and Prettier configuration
51
63
- Pre-commit hooks via Husky
@@ -74,7 +86,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
74
86
75
87
### Added
76
88
- Native MSSQL/SQL Server support via `mssql` library
77
-
-`xml2js`dependency for DBeaver config parsing
89
+
-`xml2js` for legacy XML workspace config parsing
78
90
79
91
### Fixed
80
92
- Missing `xml2js` runtime dependency that broke npm installations
@@ -84,7 +96,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
84
96
85
97
### Added
86
98
- SSL/TLS support for PostgreSQL connections
87
-
- Credential decryption from DBeaver's credentials-config.json
99
+
- Credential decryption from the workspace credentials-config.json
88
100
89
101
### Fixed
90
102
- Authentication failures with PostgreSQL (Issue #8)
@@ -94,17 +106,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
94
106
### Added
95
107
- Native PostgreSQL support via `pg` library
96
108
- Native SQLite support via sqlite3 CLI
97
-
-DBeaver CLI fallback for unsupported databases
109
+
- CLI fallback for unsupported drivers
98
110
- Business insights tracking feature
99
111
100
112
### Changed
101
-
- Query execution no longer requires DBeaver GUI for supported databases
113
+
- Query execution no longer requires the DB client GUI for supported databases
102
114
103
115
## [1.1.0] - 2024-09-XX
104
116
105
117
### Added
106
118
- Initial MCP server implementation
107
-
- Support for DBeaver 6.x (XML) and 21.x+ (JSON) config formats
119
+
- Support for legacy XML and modern JSON workspace config formats
Copy file name to clipboardExpand all lines: README.md
+44-48Lines changed: 44 additions & 48 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,11 @@
1
-
# DBeaver MCP Server
1
+
# OmniSQL MCP
2
2
3
-
MCP server that provides AI assistants access to databases through DBeaver connections.
3
+
Universal database MCP server — give AI assistants read/write access to your databases using connections already saved in your local DB client workspace (DBeaver-compatible).
<imgwidth="380"height="200"src="https://glama.ai/mcp/servers/@srthkdev/dbeaver-mcp-server/badge"alt="DBeaver Server MCP server" />
11
-
</a>
12
-
13
9
## Database Support
14
10
15
11
**Natively supported** (direct driver, fast):
@@ -21,11 +17,11 @@ MCP server that provides AI assistants access to databases through DBeaver conne
21
17
**Postgres-compatible** (routed through `pg` driver automatically):
22
18
- CockroachDB, TimescaleDB, Amazon Redshift, YugabyteDB, AlloyDB, Supabase, Neon, Citus
23
19
24
-
**Other databases**: Falls back to DBeaver CLI. Requires DBeaver to be installed and the connection configured in your DBeaver workspace. Results vary by DBeaver version.
20
+
**Other databases**: Fall back to an external CLIconfigured via `OMNISQL_CLI_PATH`. Results vary by CLI.
25
21
26
22
## Features
27
23
28
-
-Uses existing DBeaver connections (no separate config needed)
24
+
-Reuses connections already configured in your local DB client workspace — no duplicate setup
29
25
- Native query execution for PostgreSQL, MySQL/MariaDB, SQLite, SQL Server
30
26
- Connection pooling with configurable pool size and timeouts
31
27
- Transaction support (BEGIN/COMMIT/ROLLBACK)
@@ -41,12 +37,12 @@ MCP server that provides AI assistants access to databases through DBeaver conne
41
37
## Requirements
42
38
43
39
- Node.js 18+
44
-
- DBeaver with at least one configured connection
40
+
-A local DB client (DBeaver-compatible) with at least one configured connection
45
41
46
42
## Installation
47
43
48
44
```bash
49
-
npm install -g dbeaver-mcp-server
45
+
npm install -g omnisql-mcp
50
46
```
51
47
52
48
## Configuration
@@ -58,8 +54,8 @@ Add to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS)
58
54
```json
59
55
{
60
56
"mcpServers": {
61
-
"dbeaver": {
62
-
"command": "dbeaver-mcp-server"
57
+
"omnisql": {
58
+
"command": "omnisql-mcp"
63
59
}
64
60
}
65
61
}
@@ -72,8 +68,8 @@ Add to `~/.claude/settings.json`:
0 commit comments