Struct FindAllReferencesMetadata 

pub struct FindAllReferencesMetadata {
    pub references: Option<Vec<ReferenceLocation>>,
    pub total_references: Option<usize>,
    pub truncated: bool,
    pub files_referenced: usize,
    pub degraded: bool,
    pub degraded_reason: Option<DegradedReason>,
    pub actionable_guidance: Option<ActionableGuidance>,
    pub lsp_readiness: Option<String>,
    pub warm_start_in_progress: Option<bool>,
    pub duration_ms: Option<u64>,
    pub resolution_strategy: Option<String>,
    pub hint: Option<String>,
}

The metadata embedded in structured_content for find_all_references.

Fields

references: Option<Vec<ReferenceLocation>>

All reference locations for the target symbol. Empty array [] means LSP confirmed zero references. null when degraded is true — LSP was unavailable.

total_references: Option<usize>

Total number of references found (before pagination).

truncated: bool

Whether the results were truncated due to max_results.

files_referenced: usize

Total number of files containing references.

degraded: bool

Whether the reference lookup was degraded (LSP unavailable or crashed).

degraded_reason: Option<DegradedReason>

Machine-readable reason for degradation (e.g., no_lsp, lsp_crash, lsp_timeout).

actionable_guidance: Option<ActionableGuidance>

Machine-readable guidance when degraded is true.

lsp_readiness: Option<String>

LSP readiness at the time of the call.

• "ready": LSP is fully operational — results are authoritative.
• "warming_up": LSP is still indexing — results may be partial.
• "unavailable": No LSP; results degraded.

warm_start_in_progress: Option<bool>

Whether the LSP warm-start is still in progress at the time of the call.

duration_ms: Option<u64>

Wall-clock time in milliseconds that this tool call took to complete.

resolution_strategy: Option<String>

Spec 5.2: How the references were resolved. One of: lsp_references, grep_file_scoped, grep_impl_scoped, grep_global, grep_broad, treesitter_fallback.

hint: Option<String>

P2-7: Actionable hint when zero references are found and the result is not degraded. Helps agents distinguish “genuinely unused” from common false-negative scenarios like reflection or dynamic dispatch.

Trait Implementations

impl Debug for FindAllReferencesMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FindAllReferencesMetadata

fn default() -> FindAllReferencesMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FindAllReferencesMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for FindAllReferencesMetadata

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for FindAllReferencesMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.