Skip to content

Commit 4bc8c6f

Browse files
committed
docs: update doc
1 parent db102ca commit 4bc8c6f

File tree

7 files changed

+69
-42
lines changed

7 files changed

+69
-42
lines changed

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
44

55
# DBHub Development Guidelines
66

7-
DBHub is a Minimal Database MCP Server implementing the Model Context Protocol (MCP) server interface. This lightweight server bridges MCP-compatible clients (Claude Desktop, Claude Code, Cursor) with various database systems.
7+
DBHub is a zero-dependency, minimal database MCP server implementing the Model Context Protocol (MCP) server interface. This lightweight server bridges MCP-compatible clients (Claude Desktop, Claude Code, Cursor) with various database systems.
88

99
## Commands
1010

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
MCP Clients MCP Server Databases
3131
```
3232

33-
DBHub is a Minimal Database MCP Server implementing the Model Context Protocol (MCP) server interface. This lightweight gateway allows MCP-compatible clients to connect to and explore different databases:
33+
DBHub is a zero-dependency, minimal database MCP server implementing the Model Context Protocol (MCP) server interface. This lightweight gateway allows MCP-compatible clients to connect to and explore different databases:
3434

3535
- **Token Efficient**: Just two general MCP tools (execute_sql, search_objects) to minimize context window usage, plus support for custom tools
3636
- **Multi-Database**: Single interface for PostgreSQL, MySQL, MariaDB, SQL Server, and SQLite
@@ -50,6 +50,12 @@ DBHub implements MCP tools for database operations:
5050
- **[search_objects](https://dbhub.ai/tools/search-objects)**: Search and explore database schemas, tables, columns, indexes, and procedures with progressive disclosure
5151
- **[Custom Tools](https://dbhub.ai/tools/custom-tools)**: Define reusable, parameterized SQL operations in your `dbhub.toml` configuration file
5252

53+
## Workbench
54+
55+
DBHub includes a [built-in web interface](https://dbhub.ai/workbench/overview) for interacting with your database tools. It provides a visual way to execute queries, run custom tools, and view request traces without requiring an MCP client.
56+
57+
![workbench](https://raw.githubusercontent.com/bytebase/dbhub/main/docs/images/workbench/workbench.webp)
58+
5359
## Installation
5460

5561
See the full [Installation Guide](https://dbhub.ai/installation) for detailed instructions.

docs/docs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
"pages": [
3535
"workbench/overview",
3636
"workbench/tool-execution",
37-
"workbench/request-history"
37+
"workbench/request-trace"
3838
]
3939
},
4040
{

docs/index.mdx

Lines changed: 47 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ title: "Introduction"
1212
src="/images/logo/full-dark.svg"
1313
/>
1414

15-
DBHub is a minimal database MCP server that implements the Model Context Protocol server interface. This lightweight gateway enables AI-powered tools like Claude Desktop, Claude Code, Cursor, and VS Code Copilot to securely connect to and interact with your databases.
15+
DBHub is a zero-dependency, minimal database MCP server that implements the Model Context Protocol server interface. This lightweight gateway enables AI-powered tools like Claude Desktop, Claude Code, Cursor, and VS Code Copilot to securely connect to and interact with your databases.
1616

1717
```
1818
+------------------+ +--------------+ +------------------+
@@ -49,40 +49,61 @@ DBHub brings powerful database capabilities to AI coding assistants:
4949

5050
## Key Features
5151

52-
### Database Exploration
52+
### MCP Tools
5353

54-
AI assistants can discover and explore your database schema:
55-
- List schemas, tables, and columns
56-
- View table structures and relationships
57-
- Inspect indexes and stored procedures
58-
- Understand database constraints
54+
DBHub provides AI assistants with direct database access through three core tools:
55+
- **[execute_sql](/tools/execute-sql)**: Run queries with transaction support and safety controls
56+
- **[search_objects](/tools/search-objects)**: Explore schemas, tables, columns, indexes, and procedures
57+
- **[Custom Tools](/tools/custom-tools)**: Define reusable, parameterized SQL operations
5958

60-
### SQL Execution
59+
### Workbench
6160

62-
Execute SQL queries directly from AI tools:
63-
- Run SELECT queries for data analysis
64-
- Execute DDL/DML in read-write mode
65-
- Support for parameterized queries
66-
- Multi-statement execution with transaction support
61+
A [web-based interface](/workbench/overview) for running database tools and viewing request traces without requiring an MCP client.
6762

68-
### AI Assistant Capabilities
63+
## Architecture
6964

70-
DBHub enables AI assistants to:
71-
- Generate optimized SQL queries
72-
- Explain database elements and relationships
73-
- Suggest schema improvements
74-
- Debug complex queries
65+
```mermaid
66+
flowchart TB
67+
%% Human User
68+
User["Human User"]
7569
76-
### Security Features
70+
%% Workbench
71+
WB["DBHub Workbench"]
7772
78-
- **Read-only Mode**: Restrict operations to SELECT queries only
79-
- **SSH Tunneling**: Secure connections through bastion hosts
80-
- **SSL/TLS**: Encrypted database connections
81-
- **Row Limiting**: Prevent accidental large data retrieval
73+
%% AI Agent with MCP Client
74+
subgraph Agent["AI Agent"]
75+
MC["MCP Client"]
76+
end
8277
83-
### Workbench
78+
%% Configuration
79+
Config["dbhub.toml"]
80+
81+
%% DBHub Server
82+
subgraph DBHub["DBHub Server"]
83+
MCP["/mcp endpoint"]
84+
subgraph Tools["MCP Tools"]
85+
ES["execute_sql"]
86+
SO["search_objects"]
87+
CT["custom tools"]
88+
end
89+
end
90+
91+
%% Databases
92+
Databases["PostgreSQL, MySQL, SQL Server, MariaDB, SQLite"]
93+
94+
%% Connections
95+
User --> WB
96+
WB --> DBHub
97+
98+
Agent --> MC
99+
MC --> MCP
100+
MCP --> Tools
101+
102+
Config -.->|loads| DBHub
103+
Tools --> Databases
104+
```
84105

85-
A [web-based interface](/workbench/overview) for exploring data sources and executing tools directly in your browser.
106+
DBHub acts as a gateway between databases and AI agents. AI agents access databases through the `/mcp` endpoint using MCP tools, while the Workbench provides direct browser-based access for humans.
86107

87108
## Getting Started
88109

docs/workbench/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Overview"
33
description: "A web-based interface for exploring and executing database tools"
44
---
55

6-
The Workbench is DBHub's built-in web interface for interacting with your database tools. It provides a visual way to execute queries and test custom tools without requiring an MCP client.
6+
The Workbench is DBHub's built-in web interface for interacting with your database tools. It provides a visual way to execute queries, run custom tools, and view request traces without requiring an MCP client.
77

88
![workbench](https://raw.githubusercontent.com/bytebase/dbhub/main/docs/images/workbench/workbench.webp)
99

docs/workbench/request-history.mdx

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/workbench/request-trace.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: "Request Trace"
3+
description: "View recent tool execution traces"
4+
---
5+
6+
The Request Trace page (`/requests`) displays recent tool executions, helping you track queries and debug issues.
7+
8+
![request-trace](https://raw.githubusercontent.com/bytebase/dbhub/main/docs/images/workbench/request-trace.webp)
9+
10+
## Data Retention
11+
12+
Request traces are stored in memory (resets on restart), keeping the latest 100 requests per source.

0 commit comments

Comments
 (0)