Skip to content

fix(prompts): Inject raw data description and extra instructions #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gadenbuie merged 4 commits into from
Jun 23, 2026
+8 −4
Merged

fix(prompts): Inject raw data description and extra instructions #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1228e5c
fix(prompts): Inject raw data description
gadenbuie Jun 23, 2026
24719ec
fix(prompts): Inject raw extra instructions
gadenbuie Jun 23, 2026
d6810e4
chore: Git ignore shiny_bookmarks/
gadenbuie Jun 23, 2026
4eba97e
docs: Add changelog entries for raw prompt injection fix
gadenbuie Jun 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ README_files/
README.html
.DS_Store
test-results/
shiny_bookmarks/
python-package/examples/titanic.db
.quarto
*.db
Expand Down
1 change: 1 addition & 0 deletions pkg-py/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

* The system prompt is now lighter: full schema is no longer embedded upfront. Instead the LLM fetches per-table schema on demand via the new `querychat_get_schema` tool — and only when it needs to. When a `DataDict` is provided, the tool skips columns that already have descriptions, so the LLM only pays for what isn't already documented. (#195)
* The query tool result card now starts collapsed by default. Users can still expand it to see the SQL query and results. Set `QUERYCHAT_TOOL_DETAILS=expanded` to restore the previous behavior. (#239)
* Fixed `data_description` and `extra_instructions` being HTML-escaped in the system prompt. Special characters like `<`, `>`, and `&` in developer-provided descriptions and instructions are now passed to the LLM verbatim. (#258)

## [0.6.1] - 2026-05-26

Expand Down
4 changes: 2 additions & 2 deletions pkg-py/src/querychat/prompts/prompt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You have access to a {{db_type}} SQL database with the following tables:
{{/has_data_dicts}}
{{#data_description}}
<data_description>
{{data_description}}
{{{data_description}}}
</data_description>

{{/data_description}}
Expand Down Expand Up @@ -303,5 +303,5 @@ You might want to <span class="suggestion">explore the advanced features</span>
{{#extra_instructions}}
## Additional Instructions

{{extra_instructions}}
{{{extra_instructions}}}
{{/extra_instructions}}
2 changes: 2 additions & 0 deletions pkg-r/NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@

* The system prompt is now lighter: full schema is no longer embedded upfront. Instead the LLM fetches per-table schema on demand via the new `querychat_get_schema` tool — and only when it needs to. When a `data_dict` is provided, the tool skips columns that already have descriptions, so the LLM only pays for what isn't already documented. (#195)

* Fixed `data_description` and `extra_instructions` being HTML-escaped in the system prompt. Special characters like `<`, `>`, and `&` in developer-provided descriptions and instructions are now passed to the LLM verbatim. (#258)

# querychat 0.3.0

## New features
Expand Down
4 changes: 2 additions & 2 deletions pkg-r/inst/prompts/prompt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You have access to a {{db_type}} SQL database with the following tables:
{{/has_data_dicts}}
{{#data_description}}
<data_description>
{{data_description}}
{{{data_description}}}
</data_description>

{{/data_description}}
Expand Down Expand Up @@ -303,5 +303,5 @@ You might want to <span class="suggestion">explore the advanced features</span>
{{#extra_instructions}}
## Additional Instructions

{{extra_instructions}}
{{{extra_instructions}}}
{{/extra_instructions}}
Loading