schema-exploration — Claude Code skill: what it does, how to install
The schema-exploration skill for Claude Code analyzes an existing PostgreSQL database before writing queries or answering data questions.
Apache-2.0 113 installs ★ 1,886 updated 2026-10-22
npx skills add timescale/pg-aiguide --skill schema-exploration -a claude-codeWhat schema-exploration does
The agent inspects metadata using read-only pg_catalog queries to locate relevant tables, views, triggers, routines, and extensions. Approval is required before checking data-derived statistics or rows. The workflow targets PostgreSQL 18, prohibiting schema modifications, role changes, and raw execution of untrusted functions.
Queries parameterize values using $1 and $2, avoiding raw identifier interpolation. The agent establishes scope, inspects structure, validates execution plans via EXPLAIN, and reports specific findings alongside limitations such as stale statistics or missing permissions.
What it helps with
- explore an unfamiliar PostgreSQL database schema
- locate specific tables, views, triggers, and extensions in the catalog
- verify foreign keys, primary keys, and object dependencies
- validate read-only queries with plain EXPLAIN plans
Example prompts for the agent
- Explore the PostgreSQL database schema and find tables related to orders
- Check the columns and foreign keys of the accounts table
- Write a read-only query to count recent orders after checking the schema
How to install schema-exploration
1Skills CLI (Vercel)
npx skills add timescale/pg-aiguide --skill schema-exploration -a claude-code2Manually: put the files in place
~/.claude/skills/schema-exploration/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/schema-exploration/
1Skills CLI (Vercel)
npx skills add timescale/pg-aiguide --skill schema-exploration -a codex2Manually: put the files in place
.agents/skills/schema-exploration/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add timescale/pg-aiguide --skill schema-exploration -a cursor2Manually: put the files in place
.cursor/skills/schema-exploration/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install timescale/pg-aiguide skills/schema-exploration2Manually: put the files in place
.github/skills/schema-exploration/SKILL.md1Skills CLI (Vercel)
npx skills add timescale/pg-aiguide --skill schema-exploration -a gemini-cli2Platform CLI
gemini skills install https://github.com/timescale/pg-aiguide --path skills/schema-explorationManually: put the files in place
.devin/skills/schema-exploration/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add timescale/pg-aiguide --skill schema-exploration -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about schema-exploration
How to install schema-exploration in Claude Code?
Run npx skills add timescale/pg-aiguide --skill schema-exploration -a claude-code, then check ~/.claude/skills/schema-exploration/SKILL.md.
What does schema-exploration do?
It allows an AI agent to safely explore PostgreSQL database metadata and structure using read-only catalog queries.
What is required to run schema-exploration?
An active PostgreSQL database connection and user approval for inspecting data rows or statistics.
Source text
SKILL.md · Apache-2.0
--- name: schema-exploration description: | Explore an existing PostgreSQL database before answering questions about its data or writing SQL. Use this skill whenever a user asks for a query or a data-backed answer against an unfamiliar schema (counts, missing or failed records, recent changes), asks where a business concept lives, or asks how tables, joins, views, routines, triggers, RLS, or extensions work. Find the relevant objects with read-only pg_catalog queries, then request approval before inspecting data-derived statistics or rows. Not a schema-design or migration guide. license: Apache-2.0 metadata: author: tigerdata --- # Explore a PostgreSQL database Start with the user's question, not a full-database audit unless that is the explicit ask. Use the database connection already available to you; if none is available, ask for access or work from provided schema files. Stay within the database and schemas the user has authorized. Catalog metadata can reveal sensitive names or source code: do not export it unnecessarily. ## Workflow 1. Establish the current database, server version, role, and scope. Use [overview](references/overview.md) for a small inventory. Choose relevant schemas; do not assume `public` contains the application. 2. Pick the most promising object(s) and read **only** the matching drill-down reference: [tables](references/tables.md), [partitioning/inheritance](references/partitioning-and-inheritance.md), [foreign tables](references/foreign-tables.md), [views](references/views.md), [routines](references/routines.md), [triggers](references/triggers.md), [security/RLS](references/security.md), or [extensions](references/extensions.md). Follow cross-references only when the question requires them. 3. Corroborate meaning with comments, definitions, keys, and known dependencies. Names are clues, not proof of business meaning. If data-derived values would help, use [data-derived values](references/data-values.md) **only after obtaining approval** for the specific columns and access method. Ask the user when semantics remain ambiguous. 4. If the user wants SQL, follow [query authoring](references/query-authoring.md): establish join keys and grain, then validate a vetted read-only query with plain `EXPLAIN` where authorized. Do not mistake a valid plan for proof of business semantics. 5. Stop once you can answer. Report the specific schema-qualified objects and evidence, distinguish observations from inferences, and state limitations (permissions, stale statistics, missing dependencies, unknown application logic). ## Example finding Illustrative only; report facts verified in the target database: - **Observed:** `sales.orders` has a primary key on `order_id` and a foreign key from `account_id` to `sales.accounts.account_id`. - **Inferred:** `sales.orders` likely records one row per order; the keys support this, but do not establish what the business calls an “order.” - **Unresolved:** The catalog does not show whether canceled orders remain in this table. Confirm with the application owner before assuming they do. ## Safety and execution - Prefer structural catalog queries; `pg_stats` is data-derived and requires approval too. Do not change schema, data, roles, or session-wide settings without authorization. Never call discovered functions or procedures, refresh materialized views, or run `EXPLAIN ANALYZE` on unknown queries. A function marked `STABLE` or `IMMUTABLE` is not a safety guarantee. - If your client supports transactions, use a read-only transaction and a reasonable statement timeout for exploration. Metadata queries are not a license to run full-table counts or unrestricted scans. Ask before sampling data; sample only when necessary, with explicit limits and a clear understanding of table size and access controls. - All reference queries are plain PostgreSQL SQL. Bind `$1`, `$2`, etc. as values using your client's API. `psql` users can follow the optional [psql adapter](references/psql.md). **Never interpolate an untrusted object name as raw SQL**; placeholders cannot replace SQL identifiers in data queries. - Queries target PostgreSQL 18. Each version-sensitive section notes alternatives for older majors where applicable. Check `server_version_num` first. If a query fails due to permissions or version differences, report the limitation instead of guessing.
© tigerdata · Apache-2.0 · timescale/pg-aiguide