feat: add generate_schema_docs tool for database documentation#278
Open
hasithasandunlakshan wants to merge 2 commits into
Open
Conversation
…on generation in markdown and structured formats
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
Feature
What is the current behavior?
Currently, to understand the full structure of a database (tables, columns, RLS policies, triggers, and functions), an AI agent or developer must call multiple tools (e.g.,
list_tableswithverbose: true,execute_sql, etc.) or perform multiple manual queries. There is no single, consolidated way to get a documentation-ready overview of the database schema.Relevant Issue: #277
What is the new behavior?
This PR introduces a new tool,
generate_schema_docs, which provides a comprehensive, documentation-ready summary of the database schema in a single call.Key Features:
markdown(optimized for humans/AI context windows),json(optimized for programmatic use), orboth.databasefeature group and wired into the MCP server runtime.Additional context
server.test.tscovering various output formats and edge cases. All 172 unit tests are passing.