-
Notifications
You must be signed in to change notification settings - Fork 536
Model Context Protocol Server
Note: This feature is available in Enterprise and AWS editions only.
CloudBeaver can run as a Model Context Protocol (MCP) server. This allows external AI clients to execute database operations through CloudBeaver.
What is MCP
Model Context Protocol (MCP) is an open standard that enables AI applications to interact with external systems in a consistent way. Through MCP, AI agents can execute database operations and retrieve results through a standardized interface.
For general information about the protocol, see the official documentation.
The MCP server in CloudBeaver exposes a limited set of database tools. It allows the AI agent to:
- inspect database structure - catalogs, schemas, tables
- retrieve table metadata
- execute SQL and receive results
To activate the MCP server:
-
Navigate to Settings -> Administration -> Server Configuration
-
Enable the AI Integration and AI MCP Server options
-
Open the context menu for the connection where you want to use MCP and select Edit Connection.
-
Open the AI tab, select the Enable MCP checkbox, and click Save.
After you click Save, the MCP configuration section appears. It includes:
-
the generated MCP Endpoint for the selected connection
-
ready-to-copy
mcp.jsonexamples for supported MCP clientsExample:
{ "mcpServers": { "dbeaver": { "type": "http", "url": "https://server-example.com/api/mcp/projects/General/datasources/postgres-jdbc-19b9378f1f8-60bb24cfcd2979a7", "headers": { "X-API-Key": "${token}" } } } }Important: The MCP endpoint is connection-specific. Each connection has its own endpoint and must be configured separately in the client.
-
the Use OAuth authentication instead of API key option
By default, snippets use API token authentication. To use OAuth, select Use OAuth authentication instead of API key. The generated snippets are updated automatically.
Note: OAuth support depends on the MCP client. If your client doesn’t support OAuth for MCP servers, use API token authentication instead.
-
-
If you use API token authentication, generate an API access token and replace
${token}with the generated token.
After you enable MCP for a connection, use the generated configuration snippet to register the server in your MCP client.
The snippet depends on the selected authentication method:
- with API token authentication, the snippet includes the endpoint and token header
- with OAuth authentication, the client handles authentication through the OAuth flow
Client configuration is performed entirely on the client side. Refer to your client’s documentation for instructions on adding an MCP server.
| Client | Reference |
|---|---|
| Cursor | Cursor documentation |
| VS Code | VS Code documentation |
| Claude code | Claude code documentation |
| Claude Desktop | Claude Desktop documentation |
| ZED | ZED documentation |
Tip: For other MCP clients, use the generated endpoint URL and adapt the configuration according to the client’s documentation.
- Getting started
- Create connection
- Connection network options
- Supported databases
-
Drivers management
- Database authentication methods
- Database navigator
- Properties editor
- Data editor
- SQL editor
-
Entity relation diagrams
- Cloud services
- Data transfer
- General user guide
- Administration
- Server configuration
-
Server security and access configuration
- Authentication methods
- Access management
- Proxy configuration
-
Secret management
- Logs
-
Query manager
- Workspace location
- Command line parameters
-
Session manager
- Deployment options
- CloudBeaver Editions
- FAQ
- Development