Repository navigation
docs(readme): clarify setup and repository structure - #124
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
839fd89 to
0045cfc
Compare
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 839fd897e3
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - `calculator` evaluates arithmetic through a restricted AST evaluator. | ||
| - `read_file` reads files under the configured sandbox directory and blocks traversal and symlink escapes. | ||
| - `http_fetch` fetches HTTP(S) resources while blocking private, loopback, link-local, and metadata addresses. | ||
| - `sql_readonly` runs a single read-only query using a dedicated PostgreSQL role. It fails closed when that role is not configured. |
There was a problem hiding this comment.
With test dependencies installed, the default suite will fail at tests/unit/test_docs_accuracy.py::test_readme_does_not_claim_ast_validation_for_sql, which requires this bullet to name DATABASE_READONLY_URL. The rewrite also leaves readers configuring the required fail-closed SQL role without its explicit URL setting; retain that name in the summary.
AGENTS.md reference: AGENTS.md:L115-L117
Useful? React with 👍 / 👎.
Summary
Reworks the README into a practical guide to understanding and running AgentKit:
Validation: reviewed documented commands and endpoints against the current source and Compose configuration;
git diff --checkpassed. Documentation-only change.