Add structured text output for AI model context #120
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.
Add structured text output for AI model context
Description
This PR adds automatic structured text output for AI models when using a
.txt
file extension:When a filename with a
.txt
extension is provided, the package automatically generates a structured Markdown representation of the ER diagram that is specifically formatted to be used as context for AI models.Why
When working with AI models like ChatGPT or Claude, providing structured context about database relationships can significantly improve the quality of generated code. This feature allows developers to easily generate documentation about their database structure that can be fed directly to AI assistants.
Changes
.txt
file extension to generate structured outputgenerateStructuredTextRepresentation
method toGraphBuilder
classExample Output
The structured output format looks like this: