Repository navigation
[docs] Clarify Tool Use injection and parallel-call guidance - #1261
Conversation
62695d2 to
b702b89
Compare
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)
b702b89 to
e3f3bd0
Compare
sangkyoonnam
left a comment
There was a problem hiding this comment.
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)
da-daken
left a comment
There was a problem hiding this comment.
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)
|
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 |
Generated-by: Codex CLI 0.162.0-alpha.17.2 (GPT-6)
|
Thanks for catching that! Simplified those three entries and linked them to Tool Use, keeping the defaults and user-facing constraints. |
wenjin272
left a comment
There was a problem hiding this comment.
Thanks for addressing my comments. LGTM
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>
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.parallelismoption rather than thetool-call.parallelismname mentioned in the issue. Existing section anchors and the old Tool Use URL alias are preserved. No runtime behavior or configuration defaults change.Tests
qwen3:8bas the model; Python negative controls confirm a missing model is rejected.ToolCallActionTest/FunctionToolTestsuites: 30 passed. Python tool-action, function-tool, and decorator suites: 91 passed, importing the current checkout.git diff --checkpassed.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-neededdoc-not-neededdoc-includedWas this patch authored or co-authored using generative AI tooling?
Generated-by: Codex CLI 0.162.0-alpha.17.2 (GPT-6)