Is your feature request related to a problem? Please describe.
When managing multiple sources in dbhub.toml, it can be difficult for users and AI agents to understand what each connection is used for or what databases it contains. This can lead to confusion and mistakes, especially when several connections are similar.
Describe the solution you'd like
Add a description field to each [[sources]] entry in dbhub.toml, allowing users to provide a human-readable context for that connection (e.g., which databases are included, purpose, or special notes for agents).
Example
[[sources]]
id= "analytics-prod"
dsn = "postgres://user:pass@host:5432/analytics"
description = "Contains analytics-related databases (events, metrics, reporting). Used by BI dashboards and read-only analysis agents."
Describe alternatives you've considered
- Relying on naming conventions, but this is insufficient for clarity.
- Using external documentation, but this disconnects config from usage.
Additional context
- The
description field should be optional, plain-text, and visible anywhere source information is displayed.
Label: enhancement
Is your feature request related to a problem? Please describe.
When managing multiple sources in
dbhub.toml, it can be difficult for users and AI agents to understand what each connection is used for or what databases it contains. This can lead to confusion and mistakes, especially when several connections are similar.Describe the solution you'd like
Add a
descriptionfield to each[[sources]]entry indbhub.toml, allowing users to provide a human-readable context for that connection (e.g., which databases are included, purpose, or special notes for agents).Example
Describe alternatives you've considered
Additional context
descriptionfield should be optional, plain-text, and visible anywhere source information is displayed.Label: enhancement