CloudBeaver

This is a Dify tool plugin for CloudBeaver, a web-based database management tool. It lets you run SQL queries against
any database connected to your CloudBeaver server, directly from Dify agents and workflows.

Source code: https://github.com/daelynum/dify-plugin-cloudbeaver

Installation
Operations
Credentials
Compatibility
Usage
Getting started
Resources

Installation

Install the plugin from the Dify Marketplace, or upload the packaged file under Plugins -> Install
plugin -> Local Package File.

Operations

Execute SQL query - run any SQL query with support for limit, offset, ORDER BY, and WHERE filters.

Note: only connections from the Shared project in CloudBeaver are supported.

Credentials

Configure the plugin credentials once:

Field	Description
Server URL	Base URL of your CloudBeaver server, e.g.
Username	Local access username
Password	Local access password
Connection ID	ID of the CloudBeaver connection to run queries against (Shared project only)

The plugin authenticates
with local access (username/password). The
CloudBeaver server must be reachable from wherever Dify runs.

Compatibility

Runs as a tool plugin on Dify Cloud and self-hosted CloudBeaver (Community, Enterprise, or AWS Edition).

Usage

Finding the connection ID

Right-click a database in CloudBeaver's Database Navigator, select Open, and copy the ID from the connection
window (e.g. ).

Default database

The Default database field lets you specify which database or catalog to use when running SQL. Leave it empty to use the
connection's default. This helps when a single CloudBeaver connection has access to multiple databases and you want to
target a specific one.

Parameters

Required	Default	Description
no	-	Database or catalog to run the query against
yes	-	SQL query to execute
no	200	Maximum number of rows to return
no	0	Number of rows to skip
no	-	Column(s) to sort by, e.g.
no	-	Extra WHERE condition, e.g.

Execute SQL query

The Where and Order by fields are applied on top of your SQL query:

String values in Where must be quoted, e.g. . Numbers go without quotes, e.g. .

Output

The tool returns a JSON message:

Getting started

Start CloudBeaver:
Configure authentication - follow
the Local Access Authentication guide. Create a
user (login/password) or use admin credentials.
Create a database connection - follow
the Create Connection guide.
Get the connection ID - open Database Navigator, right-click a database, select Open, and copy the connection ID.
In Dify:
- Configure the CloudBeaver plugin credentials (Server URL, username, password, connection ID).
- Add the tool to an agent or workflow.
- Call it with a SQL query.