Repository navigation
docs(service): clarify startup and stdio lifecycle - #1387
Open
theamodhshetty wants to merge 1 commit into
Open
theamodhshetty wants to merge 1 commit into
theamodhshetty wants to merge 1 commit into
Conversation
Contributor
|
@DaleSeo (assignment failed) is on triage rotation this week and is the reviewer for this one. Labels come from the PR labeler. Please review the change. Automated triage. Labels are a first pass and the assigned maintainer has the final say. |
theamodhshetty
marked this pull request as ready for review
October 23, 2026 05:05
This branch has not been deployed
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.
Clarify when
ServiceExt::serve()returns and how to run the counter stdio example with a real MCP client.Motivation and Context
Refs #1143. Starting the counter executable directly in a terminal can leave
serve().awaitwaiting for peer input, which looks like a stalled server. The API docs, README and example now explain protocol startup, background message handling,waiting(), startup cancellation and Tokio stdin's blocking-read shutdown limitation. The example also gets a working Inspector command and a corrected stderr logging comment.This addresses the issue's documentation request; lifecycle and shutdown behavior are unchanged.
How Has This Been Tested?
On macOS arm64 with Rust 1.96.1:
servers_counter_stdioand ran the documented command through Inspector CLI 2.12.0: initialization succeeded,tools/listreturned eight tools, and the service stopped after input-stream closure.git diff --checkpassed.Breaking Changes
None; documentation and comments only.
Types of changes
Checklist
Additional context
No runtime error-handling changes are involved. Initially submitted as a draft under the repository's one-open-ready-PR limit. #1386 has now merged, so this documentation change is ready for maintainer review. Hosted workflows still await maintainer approval. Developed with Codex assistance; validation was run locally.