Skip to content

[docs] Clarify Tool Use injection and parallel-call guidance - #1261

Merged
wenjin272 merged 4 commits into
apache:mainfrom
daierenao:codex/docs-tool-use-1250
Oct 16, 2026
Merged

wenjin272 merged 4 commits into
apache:mainfrom
daierenao:codex/docs-tool-use-1250

Conversation

@daierenao

@daierenao daierenao commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

Closes #1250

Purpose of change

The Tool Use guide mixes user-facing configuration with internal scheduling details and leaves parameter-injection behavior spread across pages. Clarify tool declaration and registration, injection sources and override/failure rules, and parallel-call configuration, independence requirements, and timeout boundaries. Correct incomplete declaration snippets, keep async configuration-reference entries focused on user-facing constraints, and link the YAML, chat, and configuration references to the relevant sections.

Use the implemented async.batch.parallelism option rather than the tool-call.parallelism name mentioned in the issue. Existing section anchors and the old Tool Use URL alias are preserved. No runtime behavior or configuration defaults change.

Tests

  • Hugo extended 0.110.0 documentation build; checked 359 internal links/anchors across the four changed generated pages, the old Tool Use alias, and the example source links.
  • All eight Python fenced examples parse. Minimal Java/Python API wrappers validate configuration, tool/resource declaration, and ReActAgent construction. The two Python and two Java Ollama descriptor snippets also construct the actual setup and expose qwen3:8b as the model; Python negative controls confirm a missing model is rejected.
  • Clean Java reactor rebuild and focused ToolCallActionTest / FunctionToolTest suites: 30 passed. Python tool-action, function-tool, and decorator suites: 91 passed, importing the current checkout.
  • 13 focused Python timeout and execution-mode tests passed for the review follow-up; these overlap the suites above.
  • git diff --check passed.

Java validation uses JDK 26 with the Java 11 compilation target. No real Flink job, external model call, or JDK 11 runtime validation was performed. Documentation build and focused suites were rechecked after rebasing onto c8886cfa.

API

No public API changes.

Documentation

  • doc-needed
  • doc-not-needed
  • doc-included

Was this patch authored or co-authored using generative AI tooling?

  • Yes
  • No

Generated-by: Codex CLI 0.162.0-alpha.17.2 (GPT-6)

@daierenao
daierenao force-pushed the codex/docs-tool-use-1250 branch from 62695d2 to b702b89 Compare October 15, 2026 09:23
@github-actions github-actions Bot added doc-included Your PR already contains the necessary documentation updates. fixVersion/0.4.0 priority/major Default priority of the PR or issue. and removed doc-included Your PR already contains the necessary documentation updates. labels Oct 15, 2026
Explain tool declaration, runtime parameter injection, and parallel-call
configuration and constraints. Link the YAML, chat, and configuration
references to the Tool Use guide.

Related issue: apache#1250

Generated-by: Codex CLI 0.162.0-alpha.17.2 (GPT-6)
@daierenao
daierenao force-pushed the codex/docs-tool-use-1250 branch from b702b89 to e3f3bd0 Compare October 15, 2026 13:31

@sangkyoonnam sangkyoonnam left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I checked the changed statements against the Java and Python tool-call code at e3f3bd0 and ran the Python injection, override and parallelism=1 tests; the Java side is from reading. Three inline notes correct facts (the snippets, the timeout paragraph, the reconciler advice) and one is a nit. None needs a design change.

Add explicit models to Ollama setup snippets, explain timeout outcomes
and bypass conditions, remove unavailable reconciler advice, and trim
JDK scheduling detail from the user guide.

Related issue: apache#1250

Generated-by: Codex CLI 0.162.0-alpha.17.2 (GPT-6)
@github-actions github-actions Bot added doc-included Your PR already contains the necessary documentation updates. and removed doc-included Your PR already contains the necessary documentation updates. labels Oct 15, 2026

@da-daken da-daken left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for your contribution! I left two nits below; overall, LGTM. Waiting for @wenjin272 to make the final decision.

Generated-by: Codex CLI 0.162.0-alpha.17.2 (GPT-6)
@wenjin272

Copy link
Copy Markdown
Contributor

Thanks for the update! The Tool Use guide now covers the main requirements of #1250.

The Configuration table still retains some internal details that #1250 asks to remove: JDK-specific thread pools, cross-key contention, and started/unstarted durable state. Could we simplify the async.batch.parallelism, async.batch.timeout.ms, and num-async-threads entries to defaults, user-facing constraints, and links to Tool Use?

Generated-by: Codex CLI 0.162.0-alpha.17.2 (GPT-6)
@daierenao

Copy link
Copy Markdown
Contributor Author

Thanks for catching that! Simplified those three entries and linked them to Tool Use, keeping the defaults and user-facing constraints.

@github-actions github-actions Bot added doc-included Your PR already contains the necessary documentation updates. and removed doc-included Your PR already contains the necessary documentation updates. labels Oct 16, 2026

@wenjin272 wenjin272 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for addressing my comments. LGTM

@wenjin272
wenjin272 merged commit 582d7f1 into apache:main Oct 16, 2026
12 of 29 checks passed
wenjin272 added a commit that referenced this pull request Oct 16, 2026
Explain the boundary between YAML configuration and implementation code.
Clarify prompt validation, required fields, type applicability and provider
aliases. Keep tool injection and skill source behavior in their dedicated
guides, and remove maintainer-only mapping and consistency details.

Document internal child references and external subagent setups, including
examples, input schema configuration, cross-file loading order, name
uniqueness and cycle validation. Link the YAML and Subagents guides in
both directions.

Validated with Hugo and internal links/anchors in both the current tree and
a temporary documentation overlay of PR #1261. Subagent examples pass the Pydantic models and generated JSON Schema,
with the incremental fragment combined with the earlier single-agent example.

Generated-by: Codex CLI 0.153.4 (GPT-6)

Co-authored-by: Codex <codex@openai.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc-included Your PR already contains the necessary documentation updates. fixVersion/0.4.0 priority/major Default priority of the PR or issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Doc] Improve Tool Use documentation

4 participants