docs(mcp): Align search_traces ADR with search_depth schema#8472
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the MCP ADR to better match the current search_traces input schema used by the Jaeger MCP extension, so the design documentation remains aligned with user-facing behavior referenced from the extension README.
Changes:
- Replaces the documented
search_tracesinput field fromlimittosearch_depthin the ADR tool specification. - Updates the sample
search_tracesJSON input to usesearch_depth. - Adds a note explaining that MCP and Jaeger's HTTP query APIs use different parameter names for similar concepts.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| duration_min: duration string (optional, e.g., "2s", "100ms") | ||
| duration_max: duration string (optional) | ||
| limit: integer (default: 10, max: 100) | ||
| search_depth: integer (optional, default: 10, max: 100) - Maximum search depth. Depending on the storage backend, this may behave like a limit, but it is not guaranteed to be an exact SQL-style LIMIT. |
| "duration_min": "2s", // optional | ||
| "duration_max": "10s", // optional | ||
| "limit": 10 // optional: default 10, max 100 | ||
| "search_depth": 10 // optional: default 10, max 100 |
| ``` | ||
|
|
||
| > [!NOTE] | ||
| > The MCP `search_traces` tool uses `search_depth`. Jaeger's HTTP query API uses `limit`, so examples from the HTTP API are not directly interchangeable with MCP tool inputs. |
Signed-off-by: farhann_saleem <chaudaryfarhann@gmail.com>
farhann-saleem
force-pushed
the
docs/mcp-search-depth-docs-clean
branch
from
ae6d5be to
8801122
Compare
|
Addressed. The ADR now reflects that |
yurishkuro
left a comment
yurishkuro
left a comment
There was a problem hiding this comment.
ADRs are NOT user documentation, they are decision records. They typically capture the state of the system when they are written.
updates the MCP ADR docs so the documented
search_tracesinput matches the live MCP schema.ADR documents
limitforsearch_traces, but the actual MCP input type usessearch_depthWhy
The MCP README points readers to ADR-002 for design details in [README.md](jaeger/cmd/jaeger/
internal/extension/jaegermcp/README.md:15), so this ADR is effectively user-facing documentation.
The live MCP schema is:
SearchDepth intwith JSON fieldsearch_depthin search_traces.go(jaeger/cmd/jaeger/internal/extension/jaegermcp/internal/types/search_traces.go:35)
The stale docs were:
limitin 002-mcp-server.md"limit": 10in 002-mcp-server.mdChecklist
make lint testAI Usage in this PR (choose one)
See AI Usage Policy.
it was founded by manually reading -