Skip to content

docs: clarify that JSON response mode doesn't deliver notifications #1309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
felixweinberger wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −1
Draft

docs: clarify that JSON response mode doesn't deliver notifications #1309

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion src/examples/server/jsonResponseStreamableHttp.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
/**
* Example: Streamable HTTP server with JSON response mode
*
* This example demonstrates `enableJsonResponse: true`, which returns JSON responses
* instead of SSE streams. This is useful for simple request/response scenarios but
* has an important limitation: notifications (logging, progress, etc.) are NOT delivered
* to the client. Compare with simpleStreamableHttp.ts which uses SSE and delivers notifications.
*/
import { Request, Response } from 'express';
import { randomUUID } from 'node:crypto';
import { McpServer } from '../../server/mcp.js';
Expand Down Expand Up @@ -41,7 +49,9 @@ const getServer = () => {
}
);

// Register a tool that sends multiple greetings with notifications
// Register a tool that sends notifications during execution.
// NOTE: These notifications will NOT be delivered to the client in JSON response mode.
// This tool is included to demonstrate the difference vs SSE mode (see simpleStreamableHttp.ts).
server.registerTool(
'multi-greet',
{
Expand Down
Loading