
DBX MCP Server: Setup for Claude Code, Cursor and Other Apps
Lets Claude, Cursor and Codex browse schemas and run queries on the databases you saved in DBX.
DBX is a database client, and this server lets your assistant use the connections you already saved in it. It can list tables, show columns, run queries and, if you allow it, change data. It runs on your computer and uses your saved connections, so you do not paste database passwords into the assistant's config.
Set how much the assistant may do in DBX under Settings, then MCP. Choose Read only, Data read/write or Full access, and limit which connections it can see.
Good for
- Developers who already keep their databases in the DBX database client
- Anyone who wants an assistant to explain a schema or write and test SQL
- Teams that use Redis, MongoDB, Kafka, Nacos or Consul next to SQL
- Security-minded users who want a read-only default set in one place
Works in
12 should work
Tap an app to see how to set it up and any known problems.
Supports local MCP servers.
Supports local MCP servers.
Supports local MCP servers.
Supports local MCP servers.
Supports local MCP servers.
Supports local MCP servers.
Supports local MCP servers.
Supports local MCP servers.
Supports local MCP servers.
Supports local MCP servers.
Supports local MCP servers.
Supports local MCP servers.
Client does not support this transport.
Client does not support this transport.
Install dbx MCP
Claude Code
- 1
Copy this prompt.
Add the dbx MCP server to Claude Code. Run this command: claude mcp add dbx -- npx -y @dbx-app/mcp-server Then check that it loaded and tell me if I need to sign in or restart.
- 2
Paste it into Claude Code. It shows the change and asks before running it.
Requires Node.js.
Built from the package data we hold. Not yet tested by us.
Tools
Lists the database connections you saved in DBX
Returns your DBX connections with their names, groups, database types, endpoints and saved notes. Notes are visible to the assistant, so keep passwords out of them.
Try: “List my DBX connections.”
Read ·
dbx_list_connectionsLists the databases on a connection
Lists database names on a connection, limited to the ones DBX MCP settings allow.
Try: “Which databases are on the production Postgres connection?”
Read ·
dbx_list_databasesLists tables and views in a database
Lists the tables and views for a connection. For some connection types it lists collections or message topics.
Try: “Show the tables in the billing database.”
Read ·
dbx_list_tablesShows a table's columns and details
Returns column definitions and metadata for one table.
Try: “Describe the orders table.”
Read ·
dbx_describe_tableGives the assistant a compact summary of your tables and columns
Returns compact table and column context so the assistant can write correct SQL.
Try: “Build schema context for the billing database.”
Read ·
dbx_get_schema_contextLists stored procedures and functions
Lists stored procedures and functions in a schema.
Try: “What stored procedures exist in the public schema?”
Read ·
dbx_list_routinesShows the code of a stored procedure or function
Returns the full source text of a stored procedure or function.
Try: “Show me the source of calculate_invoice.”
Read ·
dbx_get_routine_sourceRuns a SQL query or MongoDB command and returns rows
Runs a query on a connection and returns 100 rows by default, up to 1000. What it may change depends on the permission mode you set in DBX: read only, data read/write or full access.
Try: “Count orders created in the last seven days.”
Delete ·
dbx_execute_queryRuns a script of several SQL statements at once
Runs a multi-statement SQL script and returns a result per statement. It can run the whole script inside one transaction.
Try: “Run these three migration statements in one transaction.”
Delete ·
dbx_execute_batchStarts a session that keeps settings between queries
Opens a session pinned to one connection so temporary tables and session settings persist across calls. Idle sessions expire after 30 minutes by default.
Try: “Open a session and create a temp table for my report.”
Network ·
dbx_open_sessionEnds a query session
Closes a session and releases its connection.
Try: “Close the session.”
Read ·
dbx_close_sessionStarts a database transaction
Begins a transaction on a transaction-enabled native MySQL session.
Try: “Begin a transaction before the updates.”
Write ·
dbx_begin_transactionSaves the changes made in a transaction
Commits the active transaction. It reports success only after MySQL acknowledges the commit.
Try: “Commit the transaction.”
Write ·
dbx_commit_transactionUndoes the changes made in a transaction
Rolls back the active transaction.
Try: “Roll back the transaction.”
Write ·
dbx_rollback_transactionRuns a Redis command
Runs a Redis command on a Redis connection. The permission mode decides which commands are allowed, and unknown commands are refused.
Try: “Run INFO memory on the Redis connection.”
Delete ·
dbx_execute_redis_commandReads Kafka messages without marking them as read
Reads up to 100 Kafka messages without committing consumer offsets. It defaults to the latest 20.
Try: “Show the latest 10 messages on the orders topic.”
Network ·
dbx_peek_messagesSends a message to a Kafka, RocketMQ or RabbitMQ topic
Sends a base64-encoded message to a topic or queue.
Try: “Send a test message to the alerts topic.”
Write ·
dbx_send_messageAdds a new database connection to DBX
Adds a connection to DBX storage.
Try: “Add a connection to my staging MySQL server.”
Write ·
dbx_add_connectionCopies an existing connection with its settings
Duplicates a DBX connection, including its credentials, tunnels and sidebar group.
Try: “Duplicate the staging connection as staging-2.”
Write ·
dbx_duplicate_connectionDeletes a connection from DBX
Removes a database connection from DBX storage.
Try: “Remove the old-test connection.”
Delete ·
dbx_remove_connectionOpens a table in the DBX desktop app
Opens a table in the running DBX app. DBX must be running.
Try: “Open the orders table in DBX.”
Read ·
dbx_open_tableRuns a query and shows the result in the DBX app
Runs a SQL query in the DBX desktop app and shows the results there. DBX must be running.
Try: “Run this query and show me the results in DBX.”
Delete ·
dbx_execute_and_showShows which Salesforce user and org a connection uses
Shows the connected Salesforce user, profile, whether the profile holds Modify All Data, and the org. Read only.
Try: “Who am I connected to Salesforce as?”
Network ·
dbx_salesforce_current_userPrepares one Salesforce record change for your approval
Step one of two. It checks a single-record insert, update or delete against policy and returns a summary and a one-time token. Nothing is sent to Salesforce yet.
Try: “Prepare an update to set this account's rating to Hot.”
Read ·
dbx_salesforce_prepare_writeApplies a prepared Salesforce change
Step two of two. It runs exactly the prepared write using its token, which is single-use and expires after 5 minutes. Salesforce cannot roll an applied write back.
Try: “Apply the prepared Salesforce update.”
Delete ·
dbx_salesforce_apply_writeLists Nacos namespaces
Lists the namespaces of a Nacos connection that DBX can display.
Try: “List the namespaces on my Nacos connection.”
Network ·
dbx_nacos_list_namespacesLists configurations in a Nacos namespace
Lists Nacos configurations with optional group, name and text filters and paging.
Try: “List the configs in the prod namespace.”
Network ·
dbx_nacos_list_configsReads one Nacos configuration
Reads the content and metadata of one Nacos configuration.
Try: “Show the config order-service.yaml.”
Network ·
dbx_nacos_get_configSearches the content of Nacos configurations
Searches configuration content in one namespace or all of them.
Try: “Find configs that mention redis.host.”
Network ·
dbx_nacos_search_configsShows the publish history of a Nacos configuration
Lists the publish history of one Nacos configuration.
Try: “Show the history of order-service.yaml.”
Network ·
dbx_nacos_config_historyCreates or overwrites a Nacos configuration
Creates or overwrites one Nacos configuration. A checksum from the read tool can be passed to avoid overwriting a concurrent change.
Try: “Publish this YAML as order-service.yaml.”
Write ·
dbx_nacos_publish_configRestores an older version of a Nacos configuration
Rolls a Nacos configuration back to a chosen history entry.
Try: “Roll order-service.yaml back to the previous version.”
Write ·
dbx_nacos_rollback_configDeletes a Nacos configuration
Deletes one Nacos configuration. The tool is marked high risk and needs a high-risk permission or desktop confirmation.
Try: “Delete the config old-service.yaml.”
Delete ·
dbx_nacos_delete_configLists Nacos services
Lists Nacos services in a namespace, optionally filtered by group and name.
Try: “List the services in the prod namespace.”
Network ·
dbx_nacos_list_servicesShows details of one Nacos service
Gets details for one Nacos service.
Try: “Show the payment service details.”
Network ·
dbx_nacos_get_serviceLists the instances of a Nacos service
Lists a service's instances with health, weight and enabled state.
Try: “Which instances of payment are healthy?”
Network ·
dbx_nacos_list_instancesTakes a Nacos instance online or offline or changes its weight
Brings a Nacos instance online or offline or changes its weight.
Try: “Take the 10.0.0.5 payment instance offline.”
Write ·
dbx_nacos_update_instanceRegisters a persistent Nacos service instance
Registers a persistent instance for a Nacos service.
Try: “Register 10.0.0.9:8080 as a payment instance.”
Write ·
dbx_nacos_register_instanceRemoves a Nacos service instance
Deregisters a Nacos service instance. It targets persistent instances unless you say otherwise.
Try: “Deregister 10.0.0.9:8080 from payment.”
Delete ·
dbx_nacos_deregister_instanceLists Consul key-value keys under a prefix
Lists Consul KV keys under a prefix, one page at a time.
Try: “List the Consul keys under config/.”
Network ·
dbx_consul_kv_listReads one Consul key
Reads one Consul KV key with its value and a version number used for safe writes.
Try: “Read the Consul key config/db/host.”
Network ·
dbx_consul_kv_getWrites one Consul key
Writes a Consul KV key. A version check is required so you do not overwrite someone else's change.
Try: “Set config/db/host to db2.internal.”
Write ·
dbx_consul_kv_putDeletes one Consul key
Deletes a Consul KV key. Marked high risk, so it needs a high-risk permission or desktop confirmation.
Try: “Delete the key config/old/flag.”
Delete ·
dbx_consul_kv_deleteLists Consul services and tags
Lists the services in the Consul catalog with their tags.
Try: “What services are in Consul?”
Network ·
dbx_consul_list_servicesLists Consul nodes
Lists the nodes in the Consul catalog.
Try: “List the Consul nodes.”
Network ·
dbx_consul_list_nodesShows the health checks for a Consul service
Lists a service's instances with their health checks.
Try: “Is the api service healthy in Consul?”
Network ·
dbx_consul_service_healthPuts a Consul service into or out of maintenance
Puts a Consul agent service into or out of maintenance mode.
Try: “Put the api service into maintenance mode.”
Write ·
dbx_consul_set_maintenanceRuns a tool that a DBX plugin provides
Calls one plugin tool by plugin id and tool name. DBX supplies the connection and credentials. What it does depends on the plugin.
Try: “Use the Kafka plugin to list topics.”
Delete ·
dbx_plugin_callUsed by the assistant behind the scenes
Lists DBX plugins that add their own tools
Lists DBX plugins that contribute tools, with how many tools and connections each has.
Try: “Which DBX plugins add tools?”
Read ·
dbx_plugin_listLists the tools a DBX plugin provides
Lists the tools of one DBX plugin, with arguments and a read-only hint.
Try: “What tools does the Kafka plugin have?”
Read ·
dbx_plugin_tools
Read from the source code
Permissions
high risk · 4 things to watch
High risk
It can query and, depending on the mode you set in DBX, change or delete data in every connection it can see. Use Read only mode and allow only the connections you need.
What it can do
- Read your data
- Create and change things
- Delete things
- Read-only modeHow to turn it on
Watch out for
Full access allows DDL and deletes
In Full access it can drop tables, truncate data and run broad updates or deletes. Pick Read only in DBX unless you need writes. github.com
It can remove connections and Nacos or Consul data
Tools can delete DBX connections, Nacos configurations and Consul keys. Delete tools are marked high risk and may need a confirmation in the DBX app. github.com
Saved connection notes are visible to the assistant
Connection notes are returned with the connection list. Do not store passwords or secrets in notes. github.com
Plugin tools are open-ended
One tool runs tools that DBX plugins provide, such as SSH or Kubernetes plugins in the source. Check which plugins are installed before enabling them. github.com
Security advisories
No published security advisories for the MCP server as of Nov 1, 2026.
1 other advisory is about the wider dbx project, not this MCP server. See them on GitHub
Technical details
| Turning on read-only | In DBX Settings > MCP choose Read only. Connection-level read-only and production protection also still apply. |
|---|---|
| Talks to | Connects to your databases and, in Web mode, to your DBX Web server. Plugin tools may reach other services |
| Sign-in and keys | Reads saved connections from DBX's own storage. DBX Web mode uses a password set in an environment variable. |
| Data retention | SQL text is not included in normal errors or logs unless you turn on debug logging. |
| Scopes |
|
Questions
Is the DBX MCP server official?
Yes. It is built by the DBX project (t8y2/dbx) and lives in the same repository as the DBX desktop app, under packages/mcp-server.
Is DBX MCP free?
Yes. The DBX project is open source under Apache-2.0, and the MCP server is a separate package from the desktop app. You need your database connections set up in DBX.
Do I need the DBX app?
You need DBX to create and store your connections. The native server can run without DBX open, but two tools that show results inside DBX need the app running.
Can I make it read-only?
Yes. Choose Read only under Settings, then MCP in DBX. The docs do not say which mode is the default, so check the setting before first use. The policy is reloaded on every request, so you do not put permission flags in the client config.
Can it run on a server or in Docker?
Yes. Set it to use a DBX Web or Docker deployment and give it the web password. It can also serve a local HTTP endpoint protected by a bearer token.
Which databases does it support?
The README names PostgreSQL, MySQL, SQLite, Redis and MongoDB as native. Other databases may need a DBX agent and Java runtime installed. Kafka, Salesforce, Nacos and Consul have their own tools.
Is there a native install without Node?
Yes. The docs recommend a native installer and also offer Homebrew, with npm as an alternative. The install box above shows the npm route.
Is this list of tools complete?
The list covers the tools registered in the source. The README mentions fewer, and plugins can add more tools at run time.
Information
updated Nov 2, 2026
- Publisher
- Official
- Package
@dbx-app/mcp-server- Registry
- npm
- Transport
- stdio
- Version
- 0.1.3
- License
- Apache-2.0
- Last commit
- Oct 31, 2026
- Open issues
- 1,352
- Listed in
- Official MCP registry
Sources
Docs, issue trackers and discussions this page is built from. Issues, quotes and findings above link to their own source.
Show all 3Hide
- DBX MCP server README · github.com
- DBX MCP docs · github.com
- DBX MCP server source · github.com