analyse-db

Analyze live SQL and NoSQL database schemas and generate docs/DB.md documentation.

2|1|Updated Mar 10, 2026
One-click install
npx skills add https://github.com/Vekta/PolyForge --skill analyse-db
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: analyse-db
Source: https://github.com/Vekta/PolyForge/tree/main/skills/analyse-db
Command: npx skills add https://github.com/Vekta/PolyForge --skill analyse-db

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of analyzing and documenting database schemas, saving developers significant time and effort in understanding and maintaining their data structures.

Core Features & Use Cases

  • Schema Extraction: Automatically detects and extracts schema information from various database types (SQL, NoSQL).
  • Live Database Connection: Connects to live databases (via Docker or direct connection) to gather real-time schema details.
  • ORM Code Analysis: Scans ORM models and migration files to understand schema evolution and query patterns.
  • Documentation Generation: Produces a comprehensive docs/DB.md file detailing tables, relations, indexes, and potential anti-patterns.
  • Use Case: After deploying a new feature that modifies the database, run /analyse-db to automatically update the database documentation, ensuring it accurately reflects the current state.

Quick Start

Run the analyse-db skill to automatically detect and analyze all databases in the project.

Frequently Asked Questions about analyse-db

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically document my database schema?

Automate database schema documentation by connecting to live databases or scanning ORM code to extract tables, relations, and indexes, generating a comprehensive DB.md file. This process automatically maps relations and detects schema anti-patterns.

Can I extract schema details from both SQL and MongoDB databases?

Yes, you can extract schema details from both SQL and MongoDB databases. The tool connects to live databases via Docker or direct connections to gather real-time schema details and map relations across these different database types.

How does ORM code analysis help map database schema evolution?

ORM code analysis maps database schema evolution by scanning ORM models and migration files to understand structural changes and query patterns. This process reveals a timeline of schema evolution and highlights potential anti-patterns within the database.

What's the best way to update database documentation after deploying schema changes?

The best way to update database documentation after deploying schema changes is to run an automated schema analysis command that scans the modified live database and ORM code. This automatically regenerates the DB.md documentation to accurately reflect the current state.

Does database schema analysis detect anti-patterns and query patterns?

Yes, database schema analysis detects anti-patterns and query patterns by scanning ORM models and migration files. It identifies potential structural issues and documents query patterns within the generated schema documentation file.