Skip to content

docs: add description frontmatter to 12 pages #398

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
laserduor wants to merge 1 commit into from
Closed

docs: add description frontmatter to 12 pages #398

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/config/command-line.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Command-Line Options"
description: "Complete reference for DBHub CLI flags, environment variables, and DSN formats"
---

DBHub connects to your database in one of two ways:
Expand Down
1 change: 1 addition & 0 deletions docs/config/debug.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Debug"
description: "Troubleshoot DBHub with the MCP Inspector and common connection fixes"
---

## MCP Inspector
Expand Down
1 change: 1 addition & 0 deletions docs/config/toml.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "TOML Configuration"
description: "Configure multiple database connections, per-source settings, and custom tools with TOML"
---

TOML configuration is the recommended way to configure DBHub for multi-database setups and advanced configurations. It provides more flexibility than command-line options or environment variables.
Expand Down
1 change: 1 addition & 0 deletions docs/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Introduction"
description: "DBHub is a minimal, token-efficient database MCP server for PostgreSQL, MySQL, SQL Server, MariaDB, and SQLite"
---

<img
Expand Down
1 change: 1 addition & 0 deletions docs/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Installation"
description: "Install DBHub via npm, Docker, MCP Bundle, or Claude Code plugin"
---

## npm
Expand Down
1 change: 1 addition & 0 deletions docs/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Quickstart"
description: "Get DBHub running with a database and connected to your AI tool in minutes"
---

This guide will walk you through setting up DBHub and connecting it to an AI tool for the first time. We'll use demo mode to get started quickly, then show you how to connect to your own database.
Expand Down
1 change: 1 addition & 0 deletions docs/tools/custom-tools.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Custom Tools"
description: "Define reusable, parameterized SQL operations as custom MCP tools"
---

Custom tools allow you to define reusable, parameterized SQL operations that are automatically registered as MCP tools. They provide type-safe interfaces for common database queries without writing repetitive code.
Expand Down
1 change: 1 addition & 0 deletions docs/tools/execute-sql.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "execute_sql"
description: "Execute SQL queries with transaction support, read-only mode, and row limiting"
---

Execute SQL queries and statements on your database with support for transactions, multiple statements, and safety controls.
Expand Down
1 change: 1 addition & 0 deletions docs/tools/explain-sql.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "explain_sql"
description: "Show a query's execution plan without executing it (opt-in)"
---

Show the execution plan for a SQL statement without running it.
Expand Down
1 change: 1 addition & 0 deletions docs/tools/health-check.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "health_check"
description: "Monitor connection pool state and buffer cache hit ratio (opt-in)"
---

Report operational health metrics for a database source: connection pool state and buffer cache hit ratio.
Expand Down
1 change: 1 addition & 0 deletions docs/tools/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Overview"
description: "Overview of DBHub MCP tools: execute_sql, search_objects, explain_sql, health_check, and custom tools"
---

## Available Tools
Expand Down
1 change: 1 addition & 0 deletions docs/tools/search-objects.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "search_objects"
description: "Search and list database schemas, tables, columns, and more with progressive disclosure"
---

Search and list database objects (schemas, tables, columns, procedures, functions, indexes) with pattern matching. This unified tool supports both targeted searches and browsing all objects, implementing progressive disclosure to minimize token usage.
Expand Down