feat(core): add opt-in periodic ping for connection health monitoring#1717
Open
travisbreaks wants to merge 1 commit intomodelcontextprotocol:mainfrom
Open
feat(core): add opt-in periodic ping for connection health monitoring#1717travisbreaks wants to merge 1 commit intomodelcontextprotocol:mainfrom
travisbreaks wants to merge 1 commit intomodelcontextprotocol:mainfrom
Conversation
Implements the missing periodic ping functionality specified in issue modelcontextprotocol#1000. Per the MCP specification, implementations SHOULD periodically issue pings to detect connection health, with configurable frequency. Changes: - Add `pingIntervalMs` option to `ProtocolOptions` (disabled by default) - Implement `startPeriodicPing()` and `stopPeriodicPing()` in Protocol - Client starts periodic ping after successful initialization - Server starts periodic ping after receiving initialized notification - Timer uses `unref()` so it does not prevent clean process exit - Ping failures are reported via `onerror` without stopping the timer - Timer is automatically cleaned up on close or unexpected disconnect Fixes modelcontextprotocol#1000 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: 51a9eae The changes in this PR will be included in the next version bump. This PR includes changesets to release 6 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
@modelcontextprotocol/client
@modelcontextprotocol/server
@modelcontextprotocol/express
@modelcontextprotocol/hono
@modelcontextprotocol/node
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
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.
Summary
pingIntervalMsoption toProtocolOptionsthat enables automatic periodic pings to verify the remote side is still responsiveinitializednotificationonerrorwithout stopping the timerunref()so it does not prevent clean Node.js process exitPer the MCP specification: "Implementations SHOULD periodically issue pings to detect connection health" with "configurable frequency."
Usage
Key design decisions
pingIntervalMsto enableunref()on the timer: the periodic ping does not keep the Node.js process alive if all other work is doneRelationship to other PRs
This complements PR #1712 (host process watchdog for stdio orphan detection). That PR detects when the host process is gone at the OS level; this PR detects when the remote MCP peer is unresponsive at the protocol level.
Fixes #1000
Test plan
should not send periodic pings when pingIntervalMs is not set(default behavior unchanged)should send periodic pings when pingIntervalMs is set and startPeriodicPing is calledshould stop periodic pings on closeshould report ping errors via onerror without stopping the timershould not start duplicate timers if startPeriodicPing is called multiple timesshould stop periodic pings when transport closes unexpectedlyChangeset
@modelcontextprotocol/core: minor,@modelcontextprotocol/client: minor,@modelcontextprotocol/server: minorCo-Authored-By: Claude Opus 4.6 (1M context) noreply@anthropic.com