docs: clarify that JSON response mode doesn't deliver notifications#1309
Closed
felixweinberger wants to merge 1 commit into
Closed
docs: clarify that JSON response mode doesn't deliver notifications#1309felixweinberger wants to merge 1 commit into
felixweinberger wants to merge 1 commit into
Conversation
Add comments explaining that enableJsonResponse mode does not deliver notifications to the client, and that the multi-greet tool is included to demonstrate the difference vs SSE mode.
|
commit: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarifies that
enableJsonResponsemode does not deliver notifications to the client.Motivation and Context
Issue #866 reported confusion about notifications being silently dropped in JSON response mode. The example includes a
multi-greettool that sends notifications, but without explanation that these won't be delivered.This was actually intentional (see PR #299: "Returning JSON is more limited in functionality as we are losing streaming tool notification/logging etc."), but the example didn't make this clear.
How Has This Been Tested?
Documentation-only change.
Breaking Changes
None.
Types of changes
Checklist
Additional context
Fixes #866