Skip to content

Commit 6eaab5b

Browse files
tianzhouclaude
andcommitted
docs: add description field to TOML source options documentation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 3309371 commit 6eaab5b

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

‎docs/config/toml.mdx‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,19 @@ Sources define database connections. Each source represents a database that DBHu
9393
```
9494
</ParamField>
9595

96+
### description
97+
98+
<ParamField path="description" type="string">
99+
Human-readable description of this data source. Helps AI models understand the purpose and contents of each database when multiple sources are configured.
100+
101+
```toml
102+
[[sources]]
103+
id = "production"
104+
description = "Production PostgreSQL database containing customer and order data"
105+
dsn = "postgres://user:pass@localhost:5432/mydb"
106+
```
107+
</ParamField>
108+
96109
### dsn
97110

98111
<ParamField path="dsn" type="string" required>
@@ -611,6 +624,7 @@ default = 10
611624
| Field | Type | Required | Description |
612625
|-------|------|----------|-------------|
613626
| `id` | string | ✅ | Unique source identifier |
627+
| `description` | string | ❌ | Human-readable description of the data source |
614628
| `dsn` | string | ✅ | Database connection string |
615629
| `lazy` | boolean | ❌ | Defer connection until first query (default: `false`) |
616630
| `connection_timeout` | number | ❌ | Connection timeout (seconds) |

0 commit comments

Comments
 (0)