Repository navigation
docs: say that -lp and list_probes list detached probes - #995
Merged
Merged
Conversation
The agent's probe list holds the probes no client is connected to, which -r can reconnect to. QuickReference and tutorial 04 called them "active", and tutorial 05 used list_probes to prove that no probe was left, which it cannot do for a probe that is still connected. The MCP list_probes now also reports the probe its own server holds (btraceio/agent-plugins), so tutorial 05 says what it covers and what it does not. Docs only; no build gate applies. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
What does this change do?
The agent's probe list (
btrace -lp, the MCPlist_probestool) holds the probes no client is connected to, the ones-rcan reconnect to. That is intentional and unchanged. The docs disagreed with it:docs/QuickReference.mdand tutorial 04 called them "active probes".list_probesto prove that no probe was left behind, which it cannot do for a probe that is still connected.This PR fixes the wording in QuickReference, tutorials 04 and 05, the
BTraceTutorial.mdtool table and the demo 06 prompts. The companion agent-plugins PR makes the MCPlist_probesalso report the probe its own server is connected to, so tutorial 05's step now says what it covers (the MCP server's own probe and detached probes) and what it does not (a probe connected through the plain CLI).Related issue
Companion: btraceio/agent-plugins#19
Scope and compatibility
Compatibility or migration notes: docs only.
Testing
spotlessCheckCommands and results:
Documentation and release impact
Release notes / follow-up work: tutorial 05's description of
list_probesmatches the agent-plugins PR; merge them together.Final checklist
🤖 Generated with Claude Code
This change is