langchain-ai/docs
1
0
Fork 0
mirror of https://github.com/langchain-ai/docs.git synced 2026-07-21 20:05:30 -04:00
Code Issues 490 Packages Projects Releases Wiki Activity

[PR #2801] [MERGED] chore: add documentation for tools stream mode #2900

New Issue
Closed
opened 2026-06-05 18:20:20 -04:00 by yindo · 0 comments
yindo commented 2026-06-05 18:20:20 -04:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/langchain-ai/docs/pull/2801
Author: @colifran
Created: 2/25/2026
Status: ✅ Merged
Merged: 2/25/2026
Merged by: @npentrel

Base: main ← Head: colifran/tool-stream

📝 Commits (4)

  • aac1d41 chore: add documentation for tools stream mode
  • ee373b2 chore: add documentation for tools stream mode
  • 3932309 chore: add documentation for tools stream mode
  • 75279d4 update

📊 Changes

1 file changed (+315 additions, -7 deletions)

View changed files

📝 src/oss/langgraph/streaming.mdx (+315 -7)

📄 Description

Overview

Adds documentation for the tools stream mode in LangGraph (JavaScript only). Updates include:

  • Intro: New bullet for “Stream tool progress” and an updated “Use multiple streaming modes” bullet that includes tools.
  • Supported stream modes: New table row for tools describing tool-call lifecycle events (on_tool_start, on_tool_event, on_tool_end, on_tool_error).
  • New section “Stream tool progress” (JS): How to use the tools stream mode to get real-time tool lifecycle events; defining tools as async generators that yield progress; consuming events in server-side code; using the useStream hook and toolProgress in React; extended example (travel agent with flight/hotel tools and progress UI); and when to use tools vs custom stream mode.

Type of change

Type: Update existing documentation

Related issues/PRs

Checklist

  • I have read the contributing guidelines
  • I have tested my changes locally using docs dev
  • All code examples have been tested and work correctly
  • I have used root relative paths for internal links
  • I have updated navigation in src/docs.json if needed

(Internal team members only / optional): Create a preview deployment as necessary using the Create Preview Branch workflow

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/langchain-ai/docs/pull/2801 **Author:** [@colifran](https://github.com/colifran) **Created:** 2/25/2026 **Status:** ✅ Merged **Merged:** 2/25/2026 **Merged by:** [@npentrel](https://github.com/npentrel) **Base:** `main` ← **Head:** `colifran/tool-stream` --- ### 📝 Commits (4) - [`aac1d41`](https://github.com/langchain-ai/docs/commit/aac1d41605e25833cccee3032aba880d60bb94d1) chore: add documentation for tools stream mode - [`ee373b2`](https://github.com/langchain-ai/docs/commit/ee373b275e4cdd871db6346af0fe6120db69c799) chore: add documentation for tools stream mode - [`3932309`](https://github.com/langchain-ai/docs/commit/393230963d384e3ecfb7e887c1a2c1dd658f8022) chore: add documentation for tools stream mode - [`75279d4`](https://github.com/langchain-ai/docs/commit/75279d4f3f1ce9fbf7d1df3c0186fb770f599e20) update ### 📊 Changes **1 file changed** (+315 additions, -7 deletions) <details> <summary>View changed files</summary> 📝 `src/oss/langgraph/streaming.mdx` (+315 -7) </details> ### 📄 Description ## Overview Adds documentation for the tools stream mode in LangGraph (JavaScript only). Updates include: - Intro: New bullet for “Stream tool progress” and an updated “Use multiple streaming modes” bullet that includes tools. - Supported stream modes: New table row for tools describing tool-call lifecycle events (on_tool_start, on_tool_event, on_tool_end, on_tool_error). - New section “Stream tool progress” (JS): How to use the tools stream mode to get real-time tool lifecycle events; defining tools as async generators that yield progress; consuming events in server-side code; using the useStream hook and toolProgress in React; extended example (travel agent with flight/hotel tools and progress UI); and when to use tools vs custom stream mode. ## Type of change **Type:** Update existing documentation ## Related issues/PRs <!-- Link to related issues, feature PRs, or discussions (if applicable) To automatically close an issue when this PR is merged, use closing keywords: - "closes #123" or "fixes #123" or "resolves #123" For regular references without auto-closing, just use: - "#123" or "See issue #123" Examples: - closes #456 (will auto-close issue #456 when PR is merged) - See #789 for context (will reference but not auto-close issue #789) --> - Feature PR: - https://github.com/langchain-ai/langchainjs/pull/10102 - https://github.com/langchain-ai/langgraphjs/pull/1984 - https://github.com/langchain-ai/langgraphjs/pull/2000 ## Checklist <!-- Put an 'x' in all boxes that apply --> - [x] I have read the [contributing guidelines](README.md) - [x] I have tested my changes locally using `docs dev` - [x] All code examples have been tested and work correctly - [x] I have used **root relative** paths for internal links - [x] I have updated navigation in `src/docs.json` if needed (Internal team members only / optional): Create a preview deployment as necessary using the [Create Preview Branch workflow](https://github.com/langchain-ai/docs/actions/workflows/create-preview-branch.yml) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-06-05 18:20:20 -04:00
yindo closed this issue 2026-06-05 18:20:20 -04:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
deepagents
docs-infra
external
external
help wanted
integration
internal
internal
javascript
js/ts
langchain
langgraph
langsmith
needs-title
pull-request
Mirrored from GitHub Pull Request
 python
reference
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/docs#2900
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?