yunfengzhou-hub opened a new pull request, #1268:
URL: https://github.com/apache/flink-agents/pull/1268
Linked issue: Closes #1258
### Purpose of change
The Sub-Agents page covered registration and the two ways a call can start,
and stopped there. A reader could not work out from it how a call behaves once
it is running. This rewrites the page around what a user has to know to run a
sub-agent in a job, and keeps every statement to public API and observable
behavior.
- Declare: both registration forms of an internal child, with the criterion
that chooses between them, and a workflow agent and a ReActAgent as children.
An external sub-agent is a setup class, and the two execution modes are
separated by what the reader can observe about their remote: whether one
request returns the result, or the remote hands back a run to query later.
- Invoke: model-driven and caller-driven delegation, both ending in the same
`submit` call, so the handle is defined once where the reader first meets it. A
new section covers what an open handle can do: batching, continuing a session,
and cancelling.
- Outcome: what a call returns, how a failure reaches a caller versus a
model, what a replay reuses rather than repeats, and what is reported under the
`subagent` scope. Restrictions collects limits that were scattered or absent.
- Navigation: the page now follows the ReAct Agent introduction, since it
uses `ReActAgent` as one of its examples.
### Tests
- Every Java snippet was assembled into one source file and compiled with
`javac --release 11` against freshly built `api`, `plan`, and `runtime`. Clean.
- All 17 Python snippets parse, and the registration snippets were executed:
both YAML forms load through the loader (agent-level and shared document
level), `AgentPlan.from_agent` builds with both external descriptor
registrations, descriptor arguments bind to the setup's fields,
`status_poll_interval_millis` defaults to 500, and a deferred `prepare` returns
a working `(id, call, reconciler)` triple.
- 103 Python sub-agent tests passed across `api`, `plan`, and `runtime`.
- Hugo extended 0.110.0, the version `docs/setup_hugo.sh` pins, builds the
site with no errors or warnings. Every `{{< ref >}}` and in-page anchor in the
changed pages was resolved against the target pages' real headings.
- Statements no test covers were checked against the implementation
directly, among them the reserved-prefix rule for MCP-advertised tools, the
absence of sub-agent reporting on the caller-driven path, and the two YAML
registration forms.
- `git diff --check` passed.
- No Flink or cross-language end-to-end jobs were run; this PR changes
documentation only.
### API
No public API or runtime behavior changes.
### Documentation
- [ ] `doc-needed`
- [ ] `doc-not-needed`
- [x] `doc-included`
### Was this patch authored or co-authored using generative AI tooling?
- [x] Yes
- [ ] No
Generated-by: Qoder (Qwen 3.8-Max)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
