Database Schema Documentation
CheckedHelps with database, schema design, documentation as part of writing, documentation, and content creation workflows.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add aj-geddes/useful-ai-prompts --skill database-schema-documentation -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
aj-geddes
Taken from the source listing. We haven't verified who controls this account.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.
Declares what it does: passed
SKILL.md parses and declares a name and a description.
SKILL.md exists, its frontmatter parses, and it declares a name and a description.
No undeclared network calls: passed
Makes no network calls.
Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.
No obfuscated payloads: passed
No encoded or obfuscated payloads.
No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.
No credential access: passed
Reads no keys, tokens, keychains or credential files.
Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.
No pipe-to-shell installers: passed
No pipe-to-shell or download-and-run installers.
No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.
Pinned to a commit: passed
Scanned aj-geddes/useful-ai-prompts at 3f5182cfd7.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- 3f5182cfd7
- Scanned
- 8 files, 389 lines
About this skill
The database-schema-documentation skill enables AI agents to read raw SQL or NoSQL schema definitions and generate clear, human-readable documentation. It automatically extracts table structures, column data types, constraints, and relationships to produce organized reference guides.
When to use it
- Onboarding new developers who need to understand complex backend architectures quickly.
- Generating API reference materials for frontend teams consuming database-driven services.
- Creating maintenance logs or changelogs when refactoring legacy database structures.
- Documenting internal tools where schema details are critical for troubleshooting data issues.
Key capabilities
- Parses raw SQL
CREATE TABLEstatements and NoSQL JSON schemas. - Identifies foreign keys, primary keys, and unique constraints within the source code.
- Outputs formatted Markdown tables summarizing fields, types, and descriptions.
- Highlights relationships between different entities in the database.
Example prompts
- "Analyze this SQL file and generate a comprehensive documentation page for our user management module."
- "Read the attached JSON schema and create a table listing all data types and their constraints."
- "Convert this raw ERD definition into a clean Markdown document explaining how orders link to customers."
Tips & gotchas
Ensure the input source contains valid syntax; malformed SQL or incomplete schema definitions may result in missing relationship details. For best results, provide context about specific business rules if they aren't explicitly defined in the schema constraints.