Database Inspector
rongxinzy/RongxinAI
探索 SQLite 或 PostgreSQL 数据库，执行安全只读查询，提供表列表、详细表结构（列/类型/约束/索引）、数据预览，并生成 Mermaid ER 图。当用户需要查看数据库架构、探索表关系、预览数据、执行只读查询，或提及 schema、ER 图、SQL 查询、数据预览、describe table、数据库探索等关键词时触发。
Explore SQLite and PostgreSQL databases: list tables, inspect schemas (columns/types/constraints), preview data, generate Mermaid ER diagrams, and run safe read-only queries.
Install Database Scout
$ npx skills add zebbern/claude-code-guide --skill database-scout -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install zebbern/claude-code-guide database-scout --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/zebbern/claude-code-guide.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/database-scout .claude/skills/database-scout && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "database-scout" agent skill from https://github.com/zebbern/claude-code-guide/tree/main/skills/database-scout into .claude/skills/database-scout/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "database-scout", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/zebbern/claude-code-guide/tree/main/skills/database-scoutType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add zebbern/claude-code-guide --skill database-scout -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install zebbern/claude-code-guide database-scout --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/zebbern/claude-code-guide.git skills-src && mkdir -p .agents/skills && cp -r skills-src/skills/database-scout .agents/skills/database-scout && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "database-scout" agent skill from https://github.com/zebbern/claude-code-guide/tree/main/skills/database-scout into .agents/skills/database-scout/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "database-scout", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add zebbern/claude-code-guide --skill database-scout -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install zebbern/claude-code-guide database-scout --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/zebbern/claude-code-guide.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/skills/database-scout .cursor/skills/database-scout && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "database-scout" agent skill from https://github.com/zebbern/claude-code-guide/tree/main/skills/database-scout into .cursor/skills/database-scout/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "database-scout", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/zebbern/claude-code-guide.git --path skills/database-scout--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add zebbern/claude-code-guide --skill database-scout -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install zebbern/claude-code-guide database-scout --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/zebbern/claude-code-guide.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/skills/database-scout .gemini/skills/database-scout && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "database-scout" agent skill from https://github.com/zebbern/claude-code-guide/tree/main/skills/database-scout into .gemini/skills/database-scout/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "database-scout", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install zebbern/claude-code-guide database-scoutInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add zebbern/claude-code-guide --skill database-scout -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/zebbern/claude-code-guide.git skills-src && mkdir -p .github/skills && cp -r skills-src/skills/database-scout .github/skills/database-scout && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "database-scout" agent skill from https://github.com/zebbern/claude-code-guide/tree/main/skills/database-scout into .github/skills/database-scout/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "database-scout", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add zebbern/claude-code-guide --skill database-scout -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install zebbern/claude-code-guide database-scout --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/zebbern/claude-code-guide.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/skills/database-scout .opencode/skills/database-scout && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "database-scout" agent skill from https://github.com/zebbern/claude-code-guide/tree/main/skills/database-scout into .opencode/skills/database-scout/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "database-scout", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
database-scout- GitHub stars
- 4.7k
- Token cost
- ~1.1k tokens
- SKILL.md length
- 247 words
- Files
- 3 (incl. scripts)
- Skills in repo
- 46
- Repo updated
- First seen
- Licence
- MIT
At a glance
Explore SQLite and PostgreSQL databases: list tables, inspect schemas (columns/types/constraints), preview data, generate Mermaid ER diagrams, and run safe read-only queries.
- Tasks that involve Diagrams
- SKILL.md covers Feature Overview, Security Mechanisms, Quick Start and Detailed Usage, plus 2 more sections
- Runs Python scripts from its folder; calls python3 and pip
- Tasks that involve SQL
What it does
Database Scout is an agent skill from zebbern/claude-code-guide. Explore SQLite and PostgreSQL databases: list tables, inspect schemas (columns/types/constraints), preview data, generate Mermaid ER diagrams, and run safe read-only queries. Triggered by requests to explore a database, view table structures, describe tables, generate diagrams, or query data, and by keywords like database exploration, schema, ER diagram, or SQL query.
Its SKILL.md is about 1.1k tokens, which your agent loads only when the skill is triggered. The skill folder holds 3 other files, including scripts (for example `scripts/db_explorer.py`).
It sits in Databases, covering Diagrams and SQL. It works with PostgreSQL, Mermaid, SQLite and SQL. The repository describes itself as: Claude Code Guide - Setup, Commands, workflows, agents, skills & tips-n-tricks from beginner to power user! The licence is MIT.
When your agent uses it
- Tasks that involve Diagrams
- Tasks that involve SQL
Example prompts
- “/database-scout”
Requirements
- Python 3
What it can do on your machine
Read from SKILL.md and the folder at commit e62775c. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
Ships 1 file in scripts/ (Python), which the agent can run.
Shell commands in SKILL.md call:
python3pip
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md. Its commands use pip, which can reach the network depending on how they are called.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Database Scout loads about 1.1k tokens when it runs. Until then it costs about 96 tokens; SKILL.md has 247 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); the scripts in this folder are not scanned.
SKILL.md
The full file from zebbern/claude-code-guide at commit e62775c, republished under its MIT licence (© zebbern). 247 words, ~1,130 tokens.
Download SKILL.mdSave it as
.claude/skills/database-scout/SKILL.md (or your agent's skills folder). This skill also uses 2 other files; get the full folder from GitHub.- name
- database-scout
- description
- Explore SQLite and PostgreSQL databases: list tables, inspect schemas (columns/types/constraints), preview data, generate Mermaid ER diagrams, and run safe read-only queries. Triggered by requests to explore a database, view table structures, describe tables, generate diagrams, or query data, and by keywords like database exploration, schema, ER diagram, or SQL query.
- license
- MIT
database-scout
Read-only exploration tool for SQLite / PostgreSQL databases — inspect table schemas, preview data, generate ER diagrams, and run safe queries.
Feature Overview
| Feature | Description |
|---|---|
| List all tables | Show tables and views in the database, with row counts |
| Inspect table schema | Column names, types, constraints (PK/FK/NOT NULL), indexes, defaults |
| Data preview | View the first N rows of a table |
| ER diagram generation | Output Mermaid erDiagram syntax, ready to render |
| Safe read-only queries | Only SELECT/WITH/EXPLAIN allowed; write operations are blocked |
Security Mechanisms
- Connection-level read-only: SQLite opens with
?mode=roURI; PostgreSQL usesSET SESSION READ ONLY - SQL whitelist: Only statements starting with SELECT / WITH / EXPLAIN / PRAGMA / SHOW are allowed
- Dangerous keyword blocking: INSERT, UPDATE, DELETE, DROP, ALTER, CREATE, and 30+ other keywords are blocked
- Multi-statement blocking: Semicolon-separated multiple SQL statements are rejected (prevents injection)
- Identifier escaping: Table names are double-quote escaped to prevent SQL injection
Quick Start
# List all tables in a SQLite database
python3 scripts/db_explorer.py --db-path data.db list-tables
# Inspect table schema
python3 scripts/db_explorer.py --db-path data.db describe users
# Preview data (default 20 rows)
python3 scripts/db_explorer.py --db-path data.db preview orders --limit 10
# Generate Mermaid ER diagram
python3 scripts/db_explorer.py --db-path data.db er-diagram
# Run a read-only query
python3 scripts/db_explorer.py --db-path data.db query "SELECT name, age FROM users WHERE age > 18 LIMIT 10"PostgreSQL
# Connect to PostgreSQL
python3 scripts/db_explorer.py --db-type postgres --dsn "host=localhost dbname=mydb user=reader" list-tables
# Inspect table schema
python3 scripts/db_explorer.py --db-type postgres --dsn "host=localhost dbname=mydb user=reader" describe ordersDetailed Usage
Parameters
| Parameter | Required | Default | Description |
|---|---|---|---|
--db-type | No | sqlite | Database type: sqlite or postgres |
--db-path | Yes (for SQLite) | — | Path to the SQLite database file |
--dsn | Yes (for PostgreSQL) | — | PostgreSQL connection string |
Subcommands
| Command | Description | Example |
|---|---|---|
list-tables | List all tables/views | list-tables |
describe <table> | Show detailed table schema | describe users |
preview <table> [--limit N / -n N] | Preview the first N rows | preview orders --limit 5 |
er-diagram | Generate Mermaid ER diagram | er-diagram |
query "<sql>" | Run a read-only SQL query | query "SELECT count(*) FROM users" |
Output Examples
list-tables
[
{"name": "users", "type": "table", "row_count": 1500},
{"name": "orders", "type": "table", "row_count": 8200},
{"name": "user_stats", "type": "view", "row_count": 1500}
]describe
{
"table": "orders",
"row_count": 8200,
"columns": [
{"cid": 0, "name": "id", "type": "INTEGER", "notnull": true, "default": null, "primary_key": true},
{"cid": 1, "name": "user_id", "type": "INTEGER", "notnull": true, "default": null, "primary_key": false},
{"cid": 2, "name": "amount", "type": "REAL", "notnull": false, "default": "0.0", "primary_key": false}
],
"foreign_keys": [
{"from": "user_id", "to_table": "users", "to_column": "id"}
],
"indexes": [
{"name": "idx_orders_user_id", "unique": false, "columns": ["user_id"]}
]
}er-diagram (Mermaid)
erDiagram
users {
INTEGER id PK
TEXT name
TEXT email
INTEGER age
}
orders {
INTEGER id PK
INTEGER user_id FK
REAL amount
TEXT created_at
}
users ||--o{ orders : "user_id"Dependencies
- Python 3.8+ (
sqlite3is a built-in module) - PostgreSQL support requires:
pip install psycopg2-binary
© zebbern, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
SKILL.md and 2 other files (scripts) in skills/database-scout of zebbern/claude-code-guide.
- SKILL.md
- LICENSE
- scripts/db_explorer.py
Open the folder on GitHubat commit e62775c
Compare with similar skills
Database Scout next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Database Scout this skillzebbern/claude-code-guide | 4.7k | — | ~1.1k | Automated safety check: Pass | MIT | |
| Database Inspectorrongxinzy/RongxinAI | 154 | — | ~835 | Automated safety check: Pass | MIT | |
| Import ExportAHS12/thoth-blueprint | 626 | — | ~499 | Automated safety check: Pass | GPL-3.0 | |
| Sql2erystemsrx/sql_to_ER | 188 | 1 repos | ~1.1k | Automated safety check: Pass | AGPL-3.0 | |
| SQL Database Support for pRESTprest/prest | 4.6k | — | ~1.6k | Automated safety check: Pass | MIT | |
| Squixeduardofuncao/squix | 273 | — | ~784 | Automated safety check: Pass | MIT |
Similar skills
Import Export
AHS12/thoth-blueprint
Change SQL, SQLite worker, DBML, JSON, Mermaid, SVG, or database export/import flows while preserving diagram semantics and round trips.
Sql2er
ystemsrx/sql_to_ER
A skill your agent uses when the user wants a Chen-model ER diagram from SQL CREATE TABLE statements or DBML, wants to rearrange or clean up an existing sql2er state, wants a skeleton-only overview…
SQL Database Support for pREST
prest/prest
Guides classifying, gap-analyzing and scaffolding support for a new SQL database in pREST, from Postgres-compatible variants to entirely new dialects.
Squix
eduardofuncao/squix
Run SQL queries across databases (Postgres, MySQL, SQLite, etc.) via the squix CLI.
Golang Database
unxed/f4
Comprehensive guide for Go database access — parameterized queries, struct scanning, NULLable columns, transactions, isolation levels, SELECT FOR UPDATE, connection pool, batch processing, context…
More from zebbern/claude-code-guide
All 46 skills in this repoCode To Diagram
zebbern/claude-code-guide
Analyze codebases and automatically generate architecture diagrams, flowcharts, and org charts.
Localization Toolkit
zebbern/claude-code-guide
This skill should be used when setting up, auditing, or enforcing internationalization/localization in UI codebases (React/TS, i18next or similar, JSON locales), including installing/configuring the…
Audit Flow
zebbern/claude-code-guide
Interactive system flow tracing across CODE, API, AUTH, DATA, NETWORK layers with SQLite persistence and Mermaid export.
Chart Image
zebbern/claude-code-guide
Generate publication-quality PNG chart images from data, supporting line, bar, area, candlestick, pie, and heatmap charts.
Code Vuln Audit
zebbern/claude-code-guide
Scan code for security issues: dependency vulnerabilities (npm/pip audit), secret leaks (regex and entropy analysis), and OWASP anti-patterns like SQL injection, XSS, or command injection.
Linux Shell Scripting
zebbern/claude-code-guide
This skill should be used when the user asks to "create bash scripts", "automate Linux tasks", "monitor system resources", "backup files", "manage users", or "write production shell scripts".
Related
Works with
Categories
Questions about Database Scout
What does Database Scout do?
Explore SQLite and PostgreSQL databases: list tables, inspect schemas (columns/types/constraints), preview data, generate Mermaid ER diagrams, and run safe read-only queries. Database Scout is an agent skill from zebbern/claude-code-guide. Explore SQLite and PostgreSQL databases: list tables, inspect schemas (columns/types/constraints), preview data, generate Mermaid ER diagrams, and run safe read-only queries.
When should I use Database Scout?
Database Scout fits situations like: tasks that involve Diagrams; tasks that involve SQL.
How do I install Database Scout in Claude Code?
Run `npx skills add zebbern/claude-code-guide --skill database-scout -a claude-code`. Or copy the skill folder (skills/database-scout in zebbern/claude-code-guide) into .claude/skills/database-scout in your project. Claude Code loads it when a task matches its description.
How do I install Database Scout in Codex?
Run `npx skills add zebbern/claude-code-guide --skill database-scout -a codex`. Or copy the skill folder (skills/database-scout in zebbern/claude-code-guide) into .agents/skills/database-scout in your project. Codex loads it when a task matches its description.
Can I use Database Scout in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add zebbern/claude-code-guide --skill database-scout -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/database-scout, .gemini/skills/database-scout, .github/skills/database-scout and .opencode/skills/database-scout in your project.
What does Database Scout need to run?
Going by SKILL.md and its folder, Database Scout needs Python for the scripts in its folder and the command-line tools its instructions call (python3 and pip). Our summary lists: Python 3.
Does Database Scout access the network?
SKILL.md contains no URLs. Its commands use pip, which can reach the network depending on how they are called. This is read from the text; nothing was executed.
Is Database Scout safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.
What licence does Database Scout use?
Database Scout is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Database Scout use?
About 1.1k tokens (SKILL.md is roughly 4.5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Database Scout?
Skills that share tags, products or a category with Database Scout: Database Inspector (rongxinzy/RongxinAI, 154 stars), Import Export (AHS12/thoth-blueprint, 626 stars), Sql2er (ystemsrx/sql_to_ER, 188 stars) and SQL Database Support for pREST (prest/prest, 4.6k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Database Scout?
zebbern (a GitHub user) maintains it in zebbern/claude-code-guide, which has 4,650 GitHub stars. The repository holds 46 skills in this directory. The repository was last updated on October 8, 2026.
Source: zebbern/claude-code-guide on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.