docs: fix factual errors in README and ARCHITECTURE - #4
Merged
Merged
Conversation
README.md and ARCHITECTURE.md claimed 12 tools but argusTools exports 13: the original 12 plus list_all_alerts. Add list_all_alerts and check_logs to the README table and update all '12' references to '13'. Also add list_all_alerts to the system prompt tool list and RCA instructions so the model knows about the registered tool.
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.
Fixes a few small factual errors in the docs that a reader will hit in the first five minutes.
What changed:
https://github.com/earendil-works/pi-coding-agent404s; the repo ishttps://github.com/earendil-works/pi. Verified the rest of the external links in README.md and ARCHITECTURE.md still resolve.argusToolsinargus-server/tools/argus-tools.tsexports 13: the original 12 pluslist_all_alerts.list_all_alertsandcheck_logswith one-line descriptions taken from each tool's own description field, so the table now has exactly one row per registered tool.list_all_alertsto the toolbelt list.list_all_alertsto the system prompt tool list and to the RCA research instructions. That tool is registered with Pi, so the model should know it exists. This is a docs-only change to the prompt; it does not alter tool behavior.Verification:
dbscenario end to end inmise run devwithqwen3.6:latest. The agent opened an incident onpgsql, proposed remediation, recovered after approval, and reachedresolvedwith an RCA. No regression.mise run typecheck,mise run test,bun run --cwd argus-ui build, anddocker compose buildall pass.Closes #5