Skip to content

docs(runtime): correct API routes, CLI flags, and RunConfig fields - #2020

Merged
joefernandez merged 6 commits into
google:mainfrom
GWeale:docs-audit-runtime
Aug 14, 2026
Merged

docs(runtime): correct API routes, CLI flags, and RunConfig fields#2020
joefernandez merged 6 commits into
google:mainfrom
GWeale:docs-audit-runtime

Conversation

@GWeale

@GWeale GWeale commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Audit of the runtime pages (event loop, api server, command line, resume, runconfig, web interface, ambient agents) plus the apps page, where documented HTTP routes, CLI flags, defaults and example code had drifted from the v2.5.0 Python source.

Changes

  • docs/runtime/ambient-agents.md — the webhook example and the curl example both POSTed to /apps/my_agent/run, which is not a route the API server serves; both now POST to /run (the body already carries app_name).
  • docs/runtime/command-line.md — the Python option table was missing six real flags (--use_local_storage/--no_use_local_storage, --state, --timeout, --in_memory, --jsonl, --default_llm_model) and did not mention that adk run <agent> "hello" sends one message and exits instead of starting an interactive session.
  • docs/runtime/web-interface/index.md--session_service_uri was documented as defaulting to in-memory; it defaults to SQLite under .adk/session.db. Adds a note that --no_use_local_storage is what falls back to in-memory services.
  • docs/runtime/api-server.md — session delete was documented as returning 204 No Content in Python; Python returns 200 OK with a null body (TypeScript is the one returning 204).
  • docs/runtime/resume.md — the curl body had a trailing comma (invalid JSON); run_async was shown called without being iterated, though it is an async generator; and the resumable-agent example had a commented-out state class, passed the enum instead of the state model to _load_agent_state, and called _create_agent_state_event with arguments it does not take — state is now set via ctx.set_agent_state(...).
  • docs/runtime/runconfig.md — adds model_input_context, history_config and translation_config; corrects the max_llm_calls limit to only reject the exact value sys.maxsize; notes save_input_blobs_as_artifacts is deprecated in Python in favor of SaveFilesAsArtifactsPlugin.
  • docs/runtime/event-loop.md — the blocking-I/O section claimed the framework prevents stalls for sync tools; Python calls a sync tool inline on the asyncio loop, so it does stall, and RunConfig.tool_thread_pool_config is the live-mode escape hatch. Also fixes the Runner module path to google.adk.runners.
  • docs/apps/index.md — the list of optional App features omitted events_compaction_config.

How this was produced

Part of a page-by-page audit of the Python docs against the google/adk-python v2.5.0 source: every import resolved against a real 2.5.0 install, every constructor kwarg checked against model_fields / inspect.signature, every documented default read off the field. A second independent pass re-derived each claim from source rather than trusting the finding, and a third conformed the new wording to the surrounding pages. mkdocs build --strict is clean.

Only Python tabs and language-neutral prose were touched — this audit had no ground truth for the Go / Java / TypeScript SDKs.

Split out of a larger audit branch so each area can be reviewed on its own.

Staged pages:

@netlify

netlify Bot commented Jul 28, 2026

Copy link
Copy Markdown

Deploy Preview for adk-docs-preview ready!

Name Link
🔨 Latest commit d82bfa3
🔍 Latest deploy log https://app.netlify.com/projects/adk-docs-preview/deploys/6a7f8c8c3af85000087ce52a
😎 Deploy Preview https://deploy-preview-2020--adk-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@GWeale
GWeale force-pushed the docs-audit-runtime branch from 68dee30 to 4156e5b Compare August 7, 2026 20:29
@GWeale
GWeale force-pushed the docs-audit-runtime branch from 4156e5b to ba1ab65 Compare August 7, 2026 20:33
@joefernandez

Copy link
Copy Markdown
Collaborator

Technical review report

Verified claims in PR #2020 against google/adk-python main @ 2353dde (post-v2.6.3, newer than the v2.5.0 the author audited).

Verdict: approve — all ~14 corrections are technically correct, no false claims found.

Highest-signal evidence:

Three non-blocking nits (detailed in the artifact): the --use_local_storage + URI combination is a hard UsageError not a no-op; local storage silently degrades to in-memory on a read-only agents dir (relevant to the new web-interface note); and SaveFilesAsArtifactsPlugin is not re-exported from google.adk.plugins — harmless as the PR words it, but a trap for a follow-up.

@joefernandez joefernandez left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with minor updates.

@joefernandez
joefernandez merged commit 5cd8d56 into google:main Aug 14, 2026
12 checks passed
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.

2 participants