Documentation
¶
Overview ¶
Package wire is the serialized form of a search answer — the JSON contract MCP's search tool and the CLI's --json output both speak. It lives beside the search service for the same reason the service exists: two surfaces that answer the same query must not drift into describing that answer differently.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FileGroup ¶
type FileGroup struct {
FilePath string `json:"file_path"`
Namespace string `json:"namespace,omitempty"`
HitCount int `json:"hit_count"`
Hits []ResultItem `json:"hits"`
}
FileGroup is one file and every hit it answered the query with.
The file is the unit of a search answer because it is the unit of reading: a caller picks a file first and a declaration inside it second. Grouping is also what let the old per-file cap go — ten hits in one file cost the reader one decision, not ten — so a file that appears here appears whole.
@intent let a caller choose between files, then read inside the one it chose.
type Limits ¶
type Limits struct {
Files int `json:"files"`
Offset int `json:"offset"`
HitBudget int `json:"hit_budget"`
}
Limits states the bounds that shaped this page, all counted in files except the budget, which only decides whether one more file joins. @intent let a caller tell a short answer from the first page of a long one.
type NextAction ¶
type NextAction struct {
Reason string `json:"reason"`
Tool string `json:"tool"`
Args map[string]any `json:"args"`
}
NextAction is one call that widens this answer, written out so an agent can make it verbatim.
Before this existed a response could say it withheld things and leave the caller with no way to reach them. Naming the tool and its arguments turns a dead-end count into a step.
@intent turn what a search withheld into a call the caller can actually make.
type Response ¶
type Response struct {
Files []FileGroup `json:"files"`
FileCount int `json:"file_count"`
WeakFiltered int `json:"weak_filtered"`
// Truncated is true when this answer did not reach every file the query
// answered with. It is never about hits: a shown file is shown whole.
Truncated bool `json:"truncated"`
Limits Limits `json:"limits"`
Next []NextAction `json:"next,omitempty"`
Note string `json:"note,omitempty"`
}
Response wraps the file list so an empty answer can still say why.
It replaced a bare JSON array. An array has nowhere to put the reason a list came back short, and a caller that reads `[]` cannot tell "nothing was indexed under those words" from "everything found was unjustifiable".
@intent make a search answer self-describing, including when it is empty.
func NewResponse ¶
NewResponse converts an evidence list into the wire payload. @requires withNamespace is true only for federated searches, where a caller needs to know which repository a hit came from. @requires query, limit and offset are the ones this list was built with, so the suggested calls repeat the caller's own request. @ensures Next is empty exactly when the answer withheld nothing. @intent keep one conversion so no two search surfaces can drift apart.
type ResultItem ¶
type ResultItem struct {
ID uint `json:"id"`
QualifiedName string `json:"qualified_name"`
Kind graph.NodeKind `json:"kind"`
Name string `json:"name"`
FilePath string `json:"file_path"`
StartLine int `json:"start_line"`
EndLine int `json:"end_line"`
// Intent is the node's own @intent tag, empty when nobody wrote one.
Intent string `json:"intent,omitempty"`
// Matched names the signals this query touched — name, path, intent — so a
// caller can tell an exact identifier hit from a hit on a written purpose.
Matched []evidence.Match `json:"matched"`
// Reason is the recorded reason the intent index answered with — set only
// when this hit came from the intent query, so its absence means the hit
// earned its place on name, path, or token overlap alone.
Reason string `json:"reason,omitempty"`
// MatchedTerms are the query terms written in Reason — the proof behind an
// intent match that token overlap alone cannot see.
MatchedTerms []string `json:"matched_terms,omitempty"`
Namespace string `json:"namespace,omitempty"`
}
ResultItem summarizes one node hit returned by full-text search. @intent preserve a stable per-item DTO for search responses. @domainRule Namespace is set only in federated (multi-namespace) mode so single-namespace responses stay unchanged.
Source Files