docs: verification-pass fixes (af server, dev_mode hallucination, Makefile PYTHONPATH)#29
Merged
Merged
Conversation
Three real hallucinations from the previous pass, all caught by tracing documented claims back to the code: - The Troubleshooting note "With dev_mode=True (the default), PR-AF retries registration on a 30s loop" was wrong on both counts. PR-AF's app.py constructs Agent() without dev_mode (so the SDK default of False applies), and the agentfield SDK has no automatic registration retry loop — failed first-time registration just logs a warning. Reworded to tell the user to restart the service after the control plane is up. - The from-source command `af` (Quick Start) and CONTRIBUTING.md's install instructions implied the AgentField CLI ships with the Python `agentfield` package via `pip install -e ".[dev]"` and could be invoked as `python -m agentfield server`. Neither is true: the `af` CLI is a Go binary installed via `curl -fsSL https://agentfield.ai/install.sh | bash` and the command is `af server`, not `af`. Fix the commands in both files and add the install one-liner up front. - `make test` invoked `pytest tests/` with no PYTHONPATH, so tests importing `pr_af.*` failed with ImportError unless the user had also done `pip install -e .` first. Set `PYTHONPATH=src` in the Makefile's `test` target so tests run cleanly without an editable install. While here, document the pre-existing `test_cost_tracker::test_async_log_success` failure in CONTRIBUTING.md so contributors know it's not their patch. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Summary
Third pass focused on verifying that everything I documented actually works. Three real hallucinations from the prior PRs (#27 / #28), all caught by tracing each documented claim back to the code:
The Troubleshooting note "With
dev_mode=True(the default), PR-AF retries registration on a 30s loop" was wrong on both counts. PR-AF'sapp.pyconstructsAgent()withoutdev_mode, so the agentfield SDK default ofFalseapplies, and the agentfield SDK has no automatic registration retry loop — failed first-time registration just logs a warning. Reworded to tell the user to restart the service after the control plane is up.The from-source command
af(Quick Start) and CONTRIBUTING.md install instructions implied the AgentField CLI ships with the Pythonagentfieldpackage viapip install -e ".[dev]"and could be invoked aspython -m agentfield server. Neither is true: theafCLI is a Go binary installed viacurl -fsSL https://agentfield.ai/install.sh | bashand the command isaf server, notaf. Fix the commands in both files and add the install one-liner up front.make testinvokedpytest tests/with noPYTHONPATH, so tests importingpr_af.*failed withModuleNotFoundErrorunless the user had also donepip install -e .first. SetPYTHONPATH=srcin the Makefile'stesttarget so tests run cleanly without an editable install. While here, document the pre-existingtest_cost_tracker::test_async_log_successfailure in CONTRIBUTING.md so contributors know it's not their patch.Test plan
🤖 Generated with Claude Code