Skip to content

docs(agent-mesh): add agent SDK streaming recipes - #4381

Merged
jruaux merged 1 commit into
iris-ga-docsfrom
codex/agent-sdk-recipes
Oct 30, 2026
Merged

jruaux merged 1 commit into
iris-ga-docsfrom
codex/agent-sdk-recipes

Conversation

@jruaux

@jruaux jruaux commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Change

Add OpenAI Agents SDK, PydanticAI, Google ADK, and LangGraph recipes to the existing FastAPI SSE guide. Each translates framework events into redis_iris.agent_mesh.fastapi_sse.StreamWriter calls using a shared event format. The guide includes authorized start/cancel route wiring, SDK session/checkpoint ownership, completion behavior, cross-process cancellation limits, and LangGraph interruption/resumption. Link the recipes from the Agent Mesh overview and guide introduction.

The recipes adapt the upstream SDK contract at 99b27df0f2b5100d4a4ac04762b004f2aeef986b, the revision pinned by redis/redis-iris#43. Framework agent/runner/graph configuration remains application-owned. The non-LangGraph recipes explicitly require additional handling for approval/deferred-tool features.

Validation

  • Hugo 0.143.1 rendered the focused Agent Mesh/context-engine segment with the repository configuration; recipe headings, local anchors, and the overview link were checked in the generated HTML. No warnings reference the changed guide. Other context-engine pages emit existing missing-example and unresolved-reference warnings; the full make all pipeline was not run.
  • All nine added Python code fences parse.
  • A temporary offline harness executes the four documented producer functions with simulated SDK events and a recording writer: text/tool mappings and completion, provider-error and cancellation propagation for each framework, PydanticAI context cleanup, ADK thought filtering and repeated-final-text handling, and LangGraph interruption. Four test methods / thirteen framework scenarios passed. This does not qualify live provider calls, installed framework compatibility, Redis persistence, or HTTP integration.
  • Whitespace checks passed. Independent read-only review found no blocking findings in the intended diff.

Existing documentation drift

The surrounding guide on iris-ga-docs still describes the older upstream active slot, active()/attach(), and sliding retention settings. Updating that API/lifecycle documentation is covered separately by #4379, also targeting iris-ga-docs. The new recipes use the pinned revision's event and cancellation contracts; publication should coordinate the surrounding guide with the intended released SDK.


Note

Low Risk
Documentation-only changes with no runtime, auth, or data-path modifications.

Overview
Adds documentation for wiring OpenAI Agents SDK, PydanticAI, Google ADK, and LangGraph into Agent Mesh FastAPI SSE via copy-paste run_turn producers that map framework streams to StreamWriter events.

The new Agent SDK recipes section defines a shared SSE event schema (delta, tool_call, tool_result, message, turn.interrupted), shows authorized start/cancel routes, and documents cancellation limits, producer errors, and human-in-the-loop (including LangGraph Command(resume=...)). The Agent Mesh overview and FastAPI guide intro now link to this section.

Reviewed by Cursor Bugbot for commit acb8afd. Bugbot is set up for automated code reviews on this repo. Configure here.

Document OpenAI Agents SDK, PydanticAI, Google ADK and LangGraph producers using the Iris SSE facade, shared authorized routes, and turn interruption handling.
@github-actions

Copy link
Copy Markdown
Contributor

🧠 Redis Memory

Found 5 related items from repository history (5 new this commit):

Memory updated at acb8afd

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes using high effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit acb8afd. Configure here.

@jruaux
jruaux merged commit 852fdc9 into iris-ga-docs Oct 30, 2026
104 checks passed
@jruaux
jruaux deleted the codex/agent-sdk-recipes branch October 30, 2026 18:08
@rbs333 rbs333 mentioned this pull request Oct 30, 2026
3 of 11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

iris Iris context engine docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants