docs(jaegermcp): Fix documentation inconsistencies in ADR-002 and README#8509
Merged
yurishkuro merged 1 commit intoMay 10, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Jaeger MCP documentation to better match the current jaegermcp tool contracts and server registration.
Changes:
- Update ADR-002 example JSON outputs to use microsecond (
*_us) fields and current critical-path field names (segments,start_offset_us,end_offset_us). - Add the missing
get_service_dependenciestool to the jaegermcp README’s “Available Tools” list.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/adr/002-mcp-server.md | Align sample outputs with current jaegermcp JSON field names/units (noting remaining inconsistencies called out in comments). |
| cmd/jaeger/internal/extension/jaegermcp/README.md | Add get_service_dependencies to match the tools registered by the MCP server. |
Comments suppressed due to low confidence (1)
docs/adr/002-mcp-server.md:190
- The
search_tracessample output omits theservicesfield, but the actual tool output includesservices(sorted list of unique service names) in each trace summary. This sample should either includeservicesor explicitly note that fields may be omitted for brevity to avoid implying the API doesn’t return it.
"traces": [
{
"trace_id": "1a2b3c4d5e6f7890",
"root_service": "frontend",
"root_span_name": "/api/checkout",
"start_time": "2024-01-15T10:30:00Z",
"duration_us": 2450000,
"span_count": 47,
"service_count": 8,
"has_errors": true
}
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Update ADR-002 sample outputs: change _ms to _us, 'path' to 'segments', 'section_start/end_ms' to 'start/end_offset_us' - Add missing get_service_dependencies to README Available Tools list Signed-off-by: Vi-shub <[email protected]>
Vi-shub
force-pushed
the
docs/fix-jaegermcp-documentation
branch
from
90b35a6 to
4ab1dd8
Compare
yurishkuro
approved these changes
May 10, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8509 +/- ##
==========================================
- Coverage 96.50% 96.49% -0.02%
==========================================
Files 325 325
Lines 17191 17191
==========================================
- Hits 16591 16589 -2
- Misses 451 452 +1
- Partials 149 150 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
CI Summary ReportMetrics Comparison✅ No significant metric changes Code Coverage❌ Coverage 97.2% (baseline 97.3%) ➡️ View CI run | View publish logs |
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.
Which problem is this PR solving?
#8508
Description of the changes
How was this change tested?
Checklist
make lint testAI Usage in this PR (choose one)
See AI Usage Policy.