docs: sync after KB store + scheduler PRs (#155 / #156)#157
Conversation
After PRs #155 (default KB store + memory tools) and #156 (default scheduler), the docs claimed nine tools, missed scheduler tools entirely in the reference, and skipped scheduler env vars. This pass syncs every stale claim flagged by the audit. Updates: - docs/reference/starter-tools.md - Corrected count: nine → twelve - New tool sections: schedule_task, list_schedules, cancel_schedule (signatures, output formats, multi-agent isolation notes) - "adding your own" snippet now threads scheduler= through get_all_tools alongside knowledge_store= - Related links include the scheduler guide - docs/reference/environment-variables.md - New "Knowledge store" section: KNOWLEDGE_DB_PATH override + the ~/.protoagent fallback - New "Audit log" section: AUDIT_PATH (used by evals/verify.py) - New "Scheduler" section: WORKSTACEAN_API_BASE/KEY/TOPIC_PREFIX, SCHEDULER_DB_DIR/INVOKE_URL/DISABLED, plus the protoLabs operators callout pointing at the ava node + secrets manager for the actual key - docs/tutorials/first-agent.md - Wizard description now mentions all twelve tools and the four middleware toggles (added Scheduler alongside Audit/Memory/ Knowledge) - docs/tutorials/first-tool.md - "Where to go next" link copy: five → twelve - docs/guides/fork-the-template.md - Tool list paragraph corrected to all twelve, with the binding-by-backend split called out - docs/guides/customize-and-deploy.md - "Add domain tools" section now mentions memory + scheduler tool binding and the middleware.* toggles for opt-out - README.md - Starter tools row now lists all twelve, grouped 4+5+3 with backend bindings shown Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
WalkthroughDocumentation is updated across six guides and reference files to reflect expansion of default starter tools from 4–9 to 12, including three new scheduler tools ( Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/reference/starter-tools.md`:
- Around line 193-199: The doc string for cancel_schedule and the implementation
message are inconsistent: the docs say "Canceled <id>." but the code returns "✓
Cancelled {job_id}". Update one side so both use the same spelling (choose
either "Canceled" or "Cancelled")—for example, change the implementation string
that currently returns "✓ Cancelled {job_id}" in the cancel_schedule-related
function to match the docs, or update the docs to match the implementation;
ensure you modify the exact formatted return string (e.g., the f-string "✓
Cancelled {job_id}") and/or the doc text "Canceled <id>." so they are identical.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 73e5896f-b8f2-41ac-a17d-949491bd80aa
⛔ Files ignored due to path filters (1)
README.mdis excluded by!*.md
📒 Files selected for processing (6)
docs/guides/customize-and-deploy.mddocs/guides/fork-the-template.mddocs/reference/environment-variables.mddocs/reference/starter-tools.mddocs/tutorials/first-agent.mddocs/tutorials/first-tool.md
|
|
||
| ```python | ||
| @tool | ||
| async def cancel_schedule(job_id: str) -> str | ||
| ``` | ||
|
|
||
| Cancel a scheduled job by id. Returns `"Canceled <id>."` or `"Error: no such job <id>."`. |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial
Minor spelling inconsistency: "Cancelled" vs "Canceled".
Line 199 documents the output as "Canceled <id>." (American spelling), but the code at tools/lg_tools.py:475 returns f"✓ Cancelled {job_id}" (British spelling). Consider standardizing on one spelling throughout the codebase.
📝 Align documentation with code
-Cancel a scheduled job by id. Returns `"Canceled <id>."` or `"Error: no such job <id>."`.
+Cancel a scheduled job by id. Returns `"✓ Cancelled <id>."` or an error message when the job doesn't exist.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/reference/starter-tools.md` around lines 193 - 199, The doc string for
cancel_schedule and the implementation message are inconsistent: the docs say
"Canceled <id>." but the code returns "✓ Cancelled {job_id}". Update one side so
both use the same spelling (choose either "Canceled" or "Cancelled")—for
example, change the implementation string that currently returns "✓ Cancelled
{job_id}" in the cancel_schedule-related function to match the docs, or update
the docs to match the implementation; ensure you modify the exact formatted
return string (e.g., the f-string "✓ Cancelled {job_id}") and/or the doc text
"Canceled <id>." so they are identical.
|
CodeRabbit's one finding is a hallucination — claims the implementation returns `"✓ Cancelled {job_id}"`, but the actual code at `tools/lg_tools.py:491` returns `f"Canceled {job_id}."` (no checkmark, US spelling) which already matches the docs verbatim. Verified by grep — no `Cancelled` or `✓` string exists anywhere in the file. Declining; nothing to fix. Merging. |
Summary
Doc sweep cleaning up stale claims after #155 (default KB store + memory tools) and #156 (default scheduler + 3 tools). Audit found 8 issues across 7 files; all addressed in one commit.
What was stale
docs/reference/starter-tools.mddocs/tutorials/first-agent.mddocs/tutorials/first-tool.mddocs/reference/environment-variables.mdWORKSTACEAN_*,SCHEDULER_*,KNOWLEDGE_DB_PATH,AUDIT_PATHdocs/guides/fork-the-template.mddocs/guides/customize-and-deploy.mdREADME.mdNotable additions
starter-tools.md— three new tool sections (schedule_task,list_schedules,cancel_schedule) with signatures, output formats, and multi-agent isolation notes.environment-variables.md— three new sections (Knowledge store, Audit log, Scheduler) covering 8 env vars previously absent. Includes a protoLabs-operators callout for the ava-node Workstacean + secrets-manager pointer.first-agent.md— wizard description now lists all 12 tools and 4 middleware toggles.Test plan
mkdocs serve(or whatever the project uses) renders cleanly — no broken anchor links.tools/lg_tools.pyandscheduler/local.py.server.py::_build_schedulerandknowledge/store.py::_resolve_pathactually read.🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation