agent_engine/tools/

catalog.rs

//! `ToolCatalog` — all locally known capabilities (spec §7.1, Task 14).
//!
//! The catalog is a passive inventory integrated into [`super::ToolRegistry`]:
//! every registry construction and mutation path (initial construction,
//! subagent variants, dynamic registration, replacement, extension merge,
//! disable) keeps exactly one truthful catalog alongside the exposed schema
//! without changing what is exposed or executable. The registry remains the
//! active behavior projection until later tasks introduce `DiscoveryIndex`,
//! `SessionToolSet`, and `ExecutionGate`.
//!
//! Insertion invariants (spec §4.2):
//! - no implementation is constructed (factories are stored, never invoked);
//! - no process is started and no network is touched;
//! - no extension handler or MCP connection method is called;
//! - no schema is exposed to the model;
//! - no execution grant is issued.
//!
//! Mutation invariants:
//! - every successful mutation advances the generation by checked (never
//!   saturating) arithmetic — a mutation cannot succeed without a new
//!   generation, so stale activation grants can never keep validating;
//! - duplicate and no-op failures do not advance the generation.

use crate::tools::{Tool, ToolOrigin};
use agent_core::BoundedText;
use serde_json::Value;
use sha2::{Digest, Sha256};
use std::collections::BTreeMap;
use std::sync::Arc;
use thiserror::Error;

pub use agent_core::orchestration::capability::{
    CatalogGeneration, CatalogGenerationOverflow, SchemaDigest, SessionActivationGrant, ToolId,
    ToolIdError,
};

/// Deferred implementation constructor. Stored at insertion, invoked only by
/// explicit later acquisition (execution-gate territory, not catalog).
pub type ToolFactory = Arc<dyn Fn() -> Arc<dyn Tool> + Send + Sync>;

/// Byte budget for raw identity fragments retained inside
/// [`CapabilitySource`] (extension/plugin/server ids and tool names).
const SOURCE_IDENTITY_MAX_BYTES: usize = 256;

/// Hex characters of SHA-256 appended to a truncated identity fragment
/// (160 bits, matching the `ToolId` digest-segment strength).
const SOURCE_TRUNCATION_DIGEST_HEX_LEN: usize = 40;

/// Bound a trust-relevant identity fragment without letting two distinct
/// oversized identities collapse into one displayed value: when truncation
/// occurs, an explicit `…#sha-<hex>` marker of the FULL raw bytes is
/// appended, so the result both records that it was cut and stays distinct
/// per original identity (up to SHA-256 collision). The source-aware
/// [`ToolId`] is always derived from the raw identity, never this bounded
/// form, so id collision resistance is unaffected.
fn bounded_identity(raw: &str) -> String {
    let bounded = BoundedText::new(raw, SOURCE_IDENTITY_MAX_BYTES);
    if !bounded.truncated {
        return bounded.text;
    }
    let digest = Sha256::digest(raw.as_bytes());
    let mut hex = String::with_capacity(SOURCE_TRUNCATION_DIGEST_HEX_LEN);
    for byte in digest.iter().take(SOURCE_TRUNCATION_DIGEST_HEX_LEN / 2) {
        use std::fmt::Write as _;
        let _ = write!(hex, "{byte:02x}");
    }
    let marker = format!("\u{2026}#sha-{hex}");
    let keep = SOURCE_IDENTITY_MAX_BYTES.saturating_sub(marker.len());
    format!("{}{marker}", BoundedText::new(raw, keep).text)
}

/// Where a capability comes from, carrying the exact runtime identities
/// (extension/plugin/server ids and per-source tool names). Drives the ID
/// namespace and, later, per-source permission policy.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum CapabilitySource {
    Builtin,
    Extension {
        extension_id: String,
        tool_name: String,
    },
    Mcp {
        server_id: String,
        server_tool_name: String,
    },
    Plugin {
        plugin_id: String,
        tool_name: String,
    },
    /// Dynamically registered with no declared origin. Kept explicit and
    /// conservative — never classified as builtin.
    Unknown {
        runtime_name: String,
    },
}

/// Permission/trust provenance recorded at catalog time. Evaluated (not
/// merely trusted) by the future execution gate.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum TrustProvenance {
    /// Compiled into this runtime; trusted as the binary itself.
    BuiltinRuntime,
    /// Declared by a locally installed extension manifest.
    ExtensionManifest { extension_id: String },
    /// Declared by local MCP server configuration.
    McpConfig { server_id: String },
    /// Declared by a plugin definition.
    PluginConfig { plugin_id: String },
    /// No verifiable provenance. Conservative fail-closed default for
    /// unclassified dynamic registrations.
    Unverified,
}

/// Conservative tool effect classes (Task 24, spec §8.2). Declared by the
/// implementation, recorded in the catalog at registration, and consumed
/// by the stream scheduler: only `ReadOnly` (or proven non-conflicting
/// keyed writes) run concurrently; everything else serializes. Unknown/
/// dynamic tools default to `NonIdempotent` — the safest class.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ToolEffect {
    /// No observable side effects; safe to run concurrently.
    ReadOnly,
    /// Repeatable write with a stable target; conflicts are detected via
    /// the concurrency key (same key => model-order serial execution).
    IdempotentWrite,
    /// Arbitrary side effects; serialized by default.
    NonIdempotent,
}

/// Where the full JSON schema for a capability lives. The catalog may hold
/// the schema locally, but never exposes it to the model.
#[derive(Clone, Debug)]
pub enum SchemaLocator {
    /// Full schema already known in-process (builtins, loaded extensions).
    Inline(Value),
}

impl SchemaLocator {
    fn schema(&self) -> &Value {
        match self {
            Self::Inline(schema) => schema,
        }
    }
}

/// One locally known capability. Construction is pure: it computes the
/// deterministic schema digest and bounds the compact descriptor, but never
/// invokes the implementation factory.
#[derive(Clone)]
pub struct CapabilityRecord {
    id: ToolId,
    source: CapabilitySource,
    summary: String,
    tags: Vec<String>,
    schema: SchemaLocator,
    schema_digest: SchemaDigest,
    factory: ToolFactory,
    provenance: TrustProvenance,
    effect: ToolEffect,
}

impl CapabilityRecord {
    /// Byte budget for the compact summary (descriptor, not full schema).
    pub const SUMMARY_MAX_BYTES: usize = 256;
    /// Maximum number of retained tags.
    pub const MAX_TAGS: usize = 8;
    /// Byte budget per retained tag.
    pub const TAG_MAX_BYTES: usize = 32;

    pub fn new(
        id: ToolId,
        source: CapabilitySource,
        summary: &str,
        tags: Vec<String>,
        schema: SchemaLocator,
        factory: ToolFactory,
        provenance: TrustProvenance,
    ) -> Self {
        let schema_digest = SchemaDigest::of_schema(schema.schema());
        let summary = BoundedText::new(summary, Self::SUMMARY_MAX_BYTES).text;
        let tags = tags
            .into_iter()
            .take(Self::MAX_TAGS)
            .map(|tag| BoundedText::new(&tag, Self::TAG_MAX_BYTES).text)
            .collect();
        Self {
            id,
            source,
            summary,
            tags,
            schema,
            schema_digest,
            factory,
            provenance,
            effect: ToolEffect::NonIdempotent,
        }
    }

    /// Catalog an already-constructed registry tool passively from its
    /// declared [`ToolOrigin`]. Reads only in-process metadata (`name`,
    /// `description`, `parameters`, `origin`): no execution, no extension
    /// handler call, no MCP connection/process/network activity, no grant.
    ///
    /// Runtime identities are encoded through the source-aware [`ToolId`]
    /// constructors, so existing uppercase/Unicode/colon-bearing names are
    /// represented exactly rather than rejected, and undeclared origins are
    /// cataloged conservatively as unknown — never invented as builtin.
    pub fn for_registered_tool(tool: &Arc<dyn Tool>) -> Self {
        let (id, source, provenance) = identity_for_tool(tool.as_ref());
        let implementation = Arc::clone(tool);
        let factory: ToolFactory = Arc::new(move || Arc::clone(&implementation));
        let mut record = Self::new(
            id,
            source,
            tool.description(),
            Vec::new(),
            SchemaLocator::Inline(tool.parameters()),
            factory,
            provenance,
        );
        // Task 24: record the implementation-declared effect class; the
        // trait default keeps unknown/dynamic tools NonIdempotent.
        record.effect = tool.effect();
        record
    }

    pub fn id(&self) -> &ToolId {
        &self.id
    }

    pub fn source(&self) -> &CapabilitySource {
        &self.source
    }

    pub fn summary(&self) -> &str {
        &self.summary
    }

    pub fn tags(&self) -> &[String] {
        &self.tags
    }

    pub fn schema_locator(&self) -> &SchemaLocator {
        &self.schema
    }

    pub fn schema_digest(&self) -> &SchemaDigest {
        &self.schema_digest
    }

    pub fn provenance(&self) -> &TrustProvenance {
        &self.provenance
    }

    /// The recorded conservative effect class (Task 24, spec §8.2).
    pub fn effect(&self) -> ToolEffect {
        self.effect
    }

    /// Construct the implementation. This is the ONLY place the stored
    /// factory is invoked; the catalog itself never calls it.
    pub fn implementation(&self) -> Arc<dyn Tool> {
        (self.factory)()
    }
}

impl std::fmt::Debug for CapabilityRecord {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("CapabilityRecord")
            .field("id", &self.id)
            .field("source", &self.source)
            .field("summary", &self.summary)
            .field("tags", &self.tags)
            .field("schema_digest", &self.schema_digest)
            .field("provenance", &self.provenance)
            .field("effect", &self.effect)
            .finish_non_exhaustive()
    }
}

/// Catalog identity of a registered tool: its exact runtime name for
/// extension tools is `<extension_id>:<tool_name>`, so the extension prefix
/// is stripped before encoding to keep the id keyed on (extension, tool).
pub(crate) fn tool_id_for(tool: &dyn Tool) -> ToolId {
    identity_for_tool(tool).0
}

fn identity_for_tool(tool: &dyn Tool) -> (ToolId, CapabilitySource, TrustProvenance) {
    match tool.origin() {
        ToolOrigin::Builtin => (
            ToolId::builtin(tool.name()),
            CapabilitySource::Builtin,
            TrustProvenance::BuiltinRuntime,
        ),
        ToolOrigin::Extension { extension_id } => {
            let runtime_name = tool.name();
            let tool_name = runtime_name
                .strip_prefix(&format!("{extension_id}:"))
                .unwrap_or(runtime_name);
            (
                ToolId::extension(&extension_id, tool_name),
                CapabilitySource::Extension {
                    extension_id: bounded_identity(&extension_id),
                    tool_name: bounded_identity(tool_name),
                },
                TrustProvenance::ExtensionManifest {
                    extension_id: bounded_identity(&extension_id),
                },
            )
        }
        ToolOrigin::Mcp {
            server_id,
            server_tool_name,
        } => (
            ToolId::mcp(&server_id, &server_tool_name),
            CapabilitySource::Mcp {
                server_id: bounded_identity(&server_id),
                server_tool_name: bounded_identity(&server_tool_name),
            },
            TrustProvenance::McpConfig {
                server_id: bounded_identity(&server_id),
            },
        ),
        ToolOrigin::Plugin {
            plugin_id,
            tool_name,
        } => (
            ToolId::plugin(&plugin_id, &tool_name),
            CapabilitySource::Plugin {
                plugin_id: bounded_identity(&plugin_id),
                tool_name: bounded_identity(&tool_name),
            },
            TrustProvenance::PluginConfig {
                plugin_id: bounded_identity(&plugin_id),
            },
        ),
        ToolOrigin::Unknown => (
            ToolId::unclassified(tool.name()),
            CapabilitySource::Unknown {
                runtime_name: bounded_identity(tool.name()),
            },
            TrustProvenance::Unverified,
        ),
    }
}

/// Typed catalog mutation failures. All fail closed without advancing the
/// catalog generation or partially applying the mutation.
#[derive(Clone, Debug, Error, PartialEq, Eq)]
pub enum CatalogError {
    #[error("duplicate tool id in catalog: {0}")]
    DuplicateToolId(ToolId),
    /// A batch registration collided on a RUNTIME name — against a tool
    /// already live in the registry or another batch member. Boot batches
    /// are strictly additive: replacement is never permitted through them.
    /// The echoed name is bounded, never raw hostile input.
    #[error("duplicate runtime tool name in additive batch: {0}")]
    DuplicateRuntimeName(String),
    #[error("invalid tool id: {0}")]
    InvalidToolId(#[from] ToolIdError),
    #[error("catalog mutation rejected: {0}")]
    GenerationExhausted(#[from] CatalogGenerationOverflow),
}

/// Inventory of all locally known capabilities, keyed by stable [`ToolId`]
/// in deterministic order, with a generation that advances on every mutation.
#[derive(Clone, Debug)]
pub struct ToolCatalog {
    entries: BTreeMap<ToolId, CapabilityRecord>,
    generation: CatalogGeneration,
}

impl ToolCatalog {
    pub fn empty() -> Self {
        Self {
            entries: BTreeMap::new(),
            generation: CatalogGeneration::initial(),
        }
    }

    /// Boundary-test support: an empty catalog resumed at an explicit
    /// generation. Not used by production paths.
    ///
    /// Deliberately NOT gated behind `#[cfg(any(test, feature = "testing"))]`:
    /// this crate's integration tests (e.g. `tests/registry_catalog.rs`)
    /// compile the library without `cfg(test)` and are run without the
    /// `testing` feature (it is enabled only through `synaps-tui`/workspace
    /// wiring), so cfg-gating would break their imports. `#[doc(hidden)]`
    /// keeps it out of the public API surface instead.
    #[doc(hidden)]
    pub fn resume_at_generation_for_tests(generation: CatalogGeneration) -> Self {
        Self {
            entries: BTreeMap::new(),
            generation,
        }
    }

    /// Boundary-test support: overwrite the generation counter in place.
    /// Grants nothing, exposes nothing, and mutates no entries; only the
    /// counter used by fail-closed advancement checks is changed. Doc-hidden
    /// instead of cfg-gated for the same reason as
    /// [`Self::resume_at_generation_for_tests`] (plain integration tests
    /// must keep compiling without the `testing` feature).
    #[doc(hidden)]
    pub fn set_generation_for_tests(&mut self, generation: CatalogGeneration) {
        self.generation = generation;
    }

    /// Read-only snapshot of the catalog integrated into a live registry.
    ///
    /// Kept as a compatibility shim over [`super::ToolRegistry::catalog`];
    /// the registry maintains its catalog through every construction and
    /// mutation path, so this is a pure read with no process start, network
    /// access, schema exposure, or execution grant.
    pub fn from_registry(registry: &super::ToolRegistry) -> Result<Self, CatalogError> {
        Ok(registry.catalog().clone())
    }

    pub fn generation(&self) -> CatalogGeneration {
        self.generation
    }

    pub fn len(&self) -> usize {
        self.entries.len()
    }

    pub fn is_empty(&self) -> bool {
        self.entries.is_empty()
    }

    pub fn get(&self, id: &ToolId) -> Option<&CapabilityRecord> {
        self.entries.get(id)
    }

    /// Iterate records in deterministic `ToolId` order.
    pub fn iter(&self) -> impl Iterator<Item = &CapabilityRecord> {
        self.entries.values()
    }

    /// Insert one capability. Duplicate IDs fail closed (no silent
    /// replacement, no generation advance); generation exhaustion fails
    /// closed (no entry change). On success the catalog generation advances
    /// by exactly one. The record's factory is stored, never invoked.
    pub fn insert(&mut self, record: CapabilityRecord) -> Result<(), CatalogError> {
        if self.entries.contains_key(&record.id) {
            return Err(CatalogError::DuplicateToolId(record.id.clone()));
        }
        let next = self.generation.checked_next()?;
        self.entries.insert(record.id.clone(), record);
        self.generation = next;
        Ok(())
    }

    /// Insert-or-replace one capability as a single mutation, optionally
    /// dropping the entry it shadows (registry replacement by runtime name
    /// can change the capability identity; the stale identity must not
    /// linger and keep validating old grants).
    ///
    /// Occupied-identity safety: if the incoming id is already cataloged and
    /// it is NOT the unchanged identity of the same-runtime-name tool being
    /// replaced (`replaced == Some(record.id)`), the mutation fails typed
    /// with [`CatalogError::DuplicateToolId`] before any entry or generation
    /// change — two distinct runtime names must never silently share one
    /// capability identity, or live tools and catalog would diverge. Fails
    /// closed without touching entries when no new generation is available.
    pub fn upsert(
        &mut self,
        replaced: Option<&ToolId>,
        record: CapabilityRecord,
    ) -> Result<(), CatalogError> {
        let same_identity_replacement = replaced == Some(&record.id);
        if !same_identity_replacement && self.entries.contains_key(&record.id) {
            return Err(CatalogError::DuplicateToolId(record.id.clone()));
        }
        let next = self.generation.checked_next()?;
        if let Some(stale) = replaced {
            if stale != &record.id {
                self.entries.remove(stale);
            }
        }
        self.entries.insert(record.id.clone(), record);
        self.generation = next;
        Ok(())
    }

    /// Advance strictly past both this catalog's generation and a prior
    /// registry generation. Used when a mutation rebuilds the catalog from
    /// scratch (e.g. `disable`): the rebuilt catalog must not reuse
    /// generation values already observed, or stale grants could survive.
    pub fn rebase_past(
        &mut self,
        prior: CatalogGeneration,
    ) -> Result<(), CatalogGenerationOverflow> {
        self.generation = self.generation.max(prior).checked_next()?;
        Ok(())
    }
}

// ── DiscoveryIndex (Task 15, spec §7.1) ─────────────────────────────────────

/// Maximum UTF-8 byte length of a discovery query.
pub const QUERY_MAX_BYTES: usize = 256;
/// Hard cap on the per-search result count budget.
pub const SEARCH_MAX_RESULTS_CAP: usize = 64;
/// Hard cap on the per-search serialized byte budget (64 KiB).
pub const SEARCH_MAX_RESULT_BYTES_CAP: usize = 64 * 1024;
/// Minimum per-search serialized byte budget: the empty serialized result
/// collection (`[]`) is 2 bytes, so no smaller budget can be honest.
pub const SEARCH_MIN_RESULT_BYTES: usize = 2;

/// Typed failure for boundary parsing of a [`DiscoveryQuery`].
#[derive(Clone, Debug, Error, PartialEq, Eq)]
pub enum DiscoveryQueryError {
    #[error("discovery query is empty")]
    Empty,
    #[error("discovery query is oversized: {actual} bytes exceeds limit {limit}")]
    Oversized { actual: usize, limit: usize },
    #[error("discovery query contains control characters")]
    ControlCharacters,
}

/// A validated, bounded, case-folded discovery query. Parse-at-boundary:
/// empty (or whitespace-only), oversized, and control-character-bearing
/// input fails typed before any search runs.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct DiscoveryQuery {
    needle: String,
}

impl DiscoveryQuery {
    pub fn parse(raw: &str) -> Result<Self, DiscoveryQueryError> {
        if raw.len() > QUERY_MAX_BYTES {
            return Err(DiscoveryQueryError::Oversized {
                actual: raw.len(),
                limit: QUERY_MAX_BYTES,
            });
        }
        let trimmed = raw.trim();
        if trimmed.is_empty() {
            return Err(DiscoveryQueryError::Empty);
        }
        // Reject C0/C1/DEL control values (newline, ESC/ANSI, NUL, …) in the
        // retained needle: the search haystack joins id/summary/tag fields
        // with `\n`, so an embedded newline could match across field
        // boundaries, and control bytes must never survive into logs.
        if trimmed.chars().any(char::is_control) {
            return Err(DiscoveryQueryError::ControlCharacters);
        }
        Ok(Self {
            needle: trimmed.to_lowercase(),
        })
    }

    /// The case-folded needle actually matched against descriptors.
    pub fn needle(&self) -> &str {
        &self.needle
    }
}

/// Typed failure for constructing [`SearchLimits`]. Zero budgets would make
/// every search vacuous; sub-minimum byte budgets could not even hold the
/// empty serialized result collection; over-cap budgets would defeat the
/// bound.
#[derive(Clone, Debug, Error, PartialEq, Eq)]
pub enum SearchLimitsError {
    #[error("search result count budget must be positive")]
    ZeroResults,
    #[error("search byte budget must be positive")]
    ZeroBytes,
    #[error(
        "search byte budget {actual} is below the serialized empty result collection size {min}"
    )]
    BytesBelowMinimum { actual: usize, min: usize },
    #[error("search result count budget {actual} exceeds cap {cap}")]
    ResultsOverCap { actual: usize, cap: usize },
    #[error("search byte budget {actual} exceeds cap {cap}")]
    BytesOverCap { actual: usize, cap: usize },
}

/// Validated positive, capped search budgets. The byte budget bounds the
/// exact compact-JSON serialization of the returned hit collection as an
/// array (entries plus `[`/`]` and comma overhead), so a caller can rely on
/// `serde_json::to_vec(results.hits())` never exceeding it.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct SearchLimits {
    max_results: usize,
    max_result_bytes: usize,
}

impl SearchLimits {
    pub fn new(max_results: usize, max_result_bytes: usize) -> Result<Self, SearchLimitsError> {
        if max_results == 0 {
            return Err(SearchLimitsError::ZeroResults);
        }
        if max_result_bytes == 0 {
            return Err(SearchLimitsError::ZeroBytes);
        }
        if max_result_bytes < SEARCH_MIN_RESULT_BYTES {
            return Err(SearchLimitsError::BytesBelowMinimum {
                actual: max_result_bytes,
                min: SEARCH_MIN_RESULT_BYTES,
            });
        }
        if max_results > SEARCH_MAX_RESULTS_CAP {
            return Err(SearchLimitsError::ResultsOverCap {
                actual: max_results,
                cap: SEARCH_MAX_RESULTS_CAP,
            });
        }
        if max_result_bytes > SEARCH_MAX_RESULT_BYTES_CAP {
            return Err(SearchLimitsError::BytesOverCap {
                actual: max_result_bytes,
                cap: SEARCH_MAX_RESULT_BYTES_CAP,
            });
        }
        Ok(Self {
            max_results,
            max_result_bytes,
        })
    }

    pub fn max_results(&self) -> usize {
        self.max_results
    }

    pub fn max_result_bytes(&self) -> usize {
        self.max_result_bytes
    }
}

/// Serializable source-class label. A label only — no raw runtime identity
/// strings, handlers, or process data.
#[derive(Clone, Copy, Debug, PartialEq, Eq, serde::Serialize)]
#[serde(rename_all = "snake_case")]
pub enum SourceClass {
    Builtin,
    Extension,
    Mcp,
    Plugin,
    Unknown,
}

impl SourceClass {
    fn of(source: &CapabilitySource) -> Self {
        match source {
            CapabilitySource::Builtin => Self::Builtin,
            CapabilitySource::Extension { .. } => Self::Extension,
            CapabilitySource::Mcp { .. } => Self::Mcp,
            CapabilitySource::Plugin { .. } => Self::Plugin,
            CapabilitySource::Unknown { .. } => Self::Unknown,
        }
    }
}

/// One compact, serializable discovery descriptor. By construction it holds
/// no schema locator, no factory, no extension/MCP handler or process data,
/// and no raw unbounded source strings — only the stable id, bounded
/// summary/tags (already bounded at catalog time), a source-class label, and
/// digest metadata.
#[derive(Clone, Debug, serde::Serialize)]
pub struct DiscoveryEntry {
    id: ToolId,
    source_class: SourceClass,
    summary: String,
    tags: Vec<String>,
    schema_digest: SchemaDigest,
}

impl DiscoveryEntry {
    pub fn id(&self) -> &ToolId {
        &self.id
    }

    pub fn source_class(&self) -> SourceClass {
        self.source_class
    }

    pub fn summary(&self) -> &str {
        &self.summary
    }

    pub fn tags(&self) -> &[String] {
        &self.tags
    }

    pub fn schema_digest(&self) -> &SchemaDigest {
        &self.schema_digest
    }
}

/// Typed failure for building a [`DiscoveryIndex`].
#[derive(Clone, Debug, Error, PartialEq, Eq)]
pub enum DiscoveryIndexError {
    #[error("failed to serialize compact descriptor for {id}: {detail}")]
    DescriptorSerialization { id: ToolId, detail: String },
}

/// Prebuilt search row: the compact entry, its exact serialized byte cost
/// (computed once at build so budget accounting includes JSON metadata
/// overhead), and its case-folded haystack.
#[derive(Clone, Debug)]
struct IndexRow {
    entry: DiscoveryEntry,
    serialized_bytes: usize,
    haystack: String,
}

/// Deterministic search outcome. `truncated` is true whenever any matching
/// entry was withheld by the count or byte budget, so callers never mistake
/// a bounded result for the complete one.
#[derive(Debug)]
pub struct SearchResults<'a> {
    generation: CatalogGeneration,
    hits: Vec<&'a DiscoveryEntry>,
    serialized_bytes: usize,
    truncated: bool,
}

impl<'a> SearchResults<'a> {
    /// The catalog generation this index snapshot was built from.
    pub fn generation(&self) -> CatalogGeneration {
        self.generation
    }

    pub fn hits(&self) -> &[&'a DiscoveryEntry] {
        &self.hits
    }

    /// Exact compact-JSON byte size of the returned hit collection serialized
    /// as an array — equal to `serde_json::to_vec(self.hits()).len()`,
    /// including the `[`/`]` container (2 bytes when empty) and separating
    /// commas. Always ≤ the byte budget the search ran with.
    pub fn serialized_bytes(&self) -> usize {
        self.serialized_bytes
    }

    pub fn truncated(&self) -> bool {
        self.truncated
    }
}

/// Bounded searchable snapshot of catalog compact descriptors (spec §7.1).
///
/// Building and searching are local and pure: no implementation acquisition,
/// no execution, no process start, no network, no full-schema read beyond
/// the digest already computed at catalog time, and no registry exposure
/// change. The snapshot pins the catalog generation; callers detect drift
/// with [`DiscoveryIndex::is_stale`] and rebuild instead of silently serving
/// stale records.
#[derive(Clone, Debug)]
pub struct DiscoveryIndex {
    generation: CatalogGeneration,
    rows: Vec<IndexRow>,
}

impl DiscoveryIndex {
    /// Build the index from catalog compact descriptors only. Reads id,
    /// source class, bounded summary/tags, and schema digest — never the
    /// schema locator or the factory.
    pub fn build(catalog: &ToolCatalog) -> Result<Self, DiscoveryIndexError> {
        let mut rows = Vec::with_capacity(catalog.len());
        // `catalog.iter()` is deterministic ToolId order; rows inherit it.
        for record in catalog.iter() {
            let entry = DiscoveryEntry {
                id: record.id().clone(),
                source_class: SourceClass::of(record.source()),
                summary: record.summary().to_string(),
                tags: record.tags().to_vec(),
                schema_digest: record.schema_digest().clone(),
            };
            let serialized_bytes = serde_json::to_vec(&entry)
                .map_err(|err| DiscoveryIndexError::DescriptorSerialization {
                    id: entry.id.clone(),
                    detail: err.to_string(),
                })?
                .len();
            let mut haystack = entry.id.as_str().to_lowercase();
            haystack.push('\n');
            haystack.push_str(&entry.summary.to_lowercase());
            for tag in &entry.tags {
                haystack.push('\n');
                haystack.push_str(&tag.to_lowercase());
            }
            rows.push(IndexRow {
                entry,
                serialized_bytes,
                haystack,
            });
        }
        Ok(Self {
            generation: catalog.generation(),
            rows,
        })
    }

    /// The catalog generation this snapshot was built from.
    pub fn generation(&self) -> CatalogGeneration {
        self.generation
    }

    /// True when the catalog has mutated since this snapshot was built. A
    /// stale index must be rebuilt, not silently served.
    pub fn is_stale(&self, catalog: &ToolCatalog) -> bool {
        self.generation != catalog.generation()
    }

    /// Deterministic, bounded, pure substring search over compact
    /// descriptors. Entries are visited in ToolId order; a matching entry is
    /// returned only if it fits both the remaining count budget and the
    /// remaining serialized byte budget. The byte budget accounts the exact
    /// compact-JSON array serialization of the returned hits — container
    /// brackets (2 bytes even when empty) plus one comma per additional
    /// entry — so `serde_json::to_vec` of the hit collection can never
    /// exceed it. The first match that does not fit stops the scan
    /// (documented bounded behavior; `truncated` reports it).
    pub fn search(&self, query: &DiscoveryQuery, limits: &SearchLimits) -> SearchResults<'_> {
        let mut hits = Vec::new();
        // Serialized cost so far of `hits` as a compact JSON array: `[]` is
        // 2 bytes; each entry adds its own bytes plus a comma when it is not
        // the first.
        let mut used_bytes = SEARCH_MIN_RESULT_BYTES;
        let mut truncated = false;
        for row in &self.rows {
            if !row.haystack.contains(query.needle()) {
                continue;
            }
            let separator = usize::from(!hits.is_empty());
            let next_bytes = used_bytes
                .checked_add(separator)
                .and_then(|bytes| bytes.checked_add(row.serialized_bytes));
            let fits = match next_bytes {
                Some(bytes) => bytes <= limits.max_result_bytes(),
                // Overflow can only mean "far beyond any budget".
                None => false,
            };
            if hits.len() == limits.max_results() || !fits {
                truncated = true;
                break;
            }
            used_bytes = next_bytes.expect("fits implies no overflow");
            hits.push(&row.entry);
        }
        SearchResults {
            generation: self.generation,
            hits,
            serialized_bytes: used_bytes,
            truncated,
        }
    }
}