feat(mcp): expose explain parameter for retrieval score traces#433
Open
feat(mcp): expose explain parameter for retrieval score traces#433
Conversation
Add optional explain boolean to the MCP query tool and REST /query endpoint. When enabled, each result includes FTS scores, vector scores, RRF fusion breakdown, and rerank blend weights for debugging query quality. The SDK already supports explain on both hybridQuery() and structuredSearch() — this plumbs it through to MCP consumers. Co-Authored-By: Claude <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.
Problem
The CLI
qmd query --explainflag includes detailed retrieval score traces per result — FTS scores, vector scores, RRF fusion breakdown, reranker blend weights, and per-source contributions. This is a shipped v2.0.1 feature.However, the MCP
querytool does not expose this option. MCP clients cannot debug query quality, understand score composition, or tune search parameters without dropping to the CLI.Fix
Add an optional
explainboolean parameter to the MCPquerytool (default:false). When enabled, passexplain: truethrough tostructuredSearch()and include theHybridQueryExplainobject on each result.Changes:
SearchResultItemtype with optionalexplainfieldexplainto MCP tool input schemaexplainthrough in both MCP tool handler and REST/queryendpointTesting
Built and tested locally against a 7,665 document index:
searches: [{type: "lex", query: "boot gate"}]truesearches: [{type: "lex", query: "boot gate"}]falsesearches: [{type: "lex", query: "boot gate"}]Example explain output:
Existing queries without
explainreturn results unchanged — no breaking changes.Environment