Skip to content

docs: document /query ?format= and add intent-driven output guidance - #13

Merged
0xeb merged 1 commit into
mainfrom
feat/output-format-and-guidance
Jun 23, 2026
Merged

docs: document /query ?format= and add intent-driven output guidance#13
0xeb merged 1 commit into
mainfrom
feat/output-format-and-guidance

Conversation

@0xeb

@0xeb 0xeb commented Jun 23, 2026

Copy link
Copy Markdown
Owner

Follow-on to the libxsql v1.0.7 bump (#12), documenting the new ?format= option and refining agent output guidance. Docs/prompt/help-text only — no behavior change.

  • README: ?format=json|text|csv|tsv curl usage for the --serve HTTP API.
  • /help text (src/lib/src/http.cpp): list the format= query option.
  • prompts/ghidrasql_agent.md: rework 'Output Guidelines' into Selection / Fidelity / Mechanics — answer questions directly vs. dump tables, show real artifacts, and consume the JSON envelope rather than piping /query through python/jq/awk (which drops success/elapsed_ms/error).

Compiles clean; rebased onto main so the (now-redundant) v1.0.7 pin hunk is dropped.

- Bump libxsql pin v1.0.5 -> v1.0.7 (brings ?format=text|csv|tsv on /query,
  handled in the shared thinclient; JSON stays the default).
- Document format= in the HTTP /help text and README.
- Rewrite agent guide 'ALWAYS Show Actual Data' into Selection/Fidelity/
  Mechanics: decide display by intent, show real artifacts, consume the JSON
  envelope rather than piping through a reformatter.
@0xeb
0xeb merged commit 8945b74 into main Jun 23, 2026
2 of 8 checks passed
@0xeb
0xeb deleted the feat/output-format-and-guidance branch June 23, 2026 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant