Component

core/ai-tool/retrieval

A read-only tool that fetches reference material by similarity, so an agent can ground an answer in a deployment's own documents rather than only in what the model already holds. It declares a required socket onto a datastore whose engine serves similarity search — vector, semantic-memory or search — so the store is resolved in the topology rather than configured in a prompt. The developer sets how many matches a lookup returns, defaulting to five. Its effect is pinned read-only in its own schema. Realized on Kubernetes as a Knative Service, which admits an inbound call while the tool is running no replicas, so the tool occupies no compute between the calls that invoke it. It publishes a host, port, endpoint and protocol, and a consumer wires to those without naming how the tool runs. The catalog pins no image, so nothing renders until the Release sets `infra.image`. The store's address reaches the tool's code under default variable names; an `inject:` block on the connection delivers instead, as variables or files, the names that code reads. The component's own `inject:` block takes `env` and `file` entries too, and one reading a value of the tool alone replaces that value's default variable name.

Version

1.0.01.0.1

Provenance

OfficialSigned by a signing identity this catalog recognizes as an official publisher.
Content digest
sha256:773b2b12397c8955789224669697da50fda0b5a16df34b17427e635309d60949
Published
2026-11-10T10:10:06Z
Signing identity
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Signature

  • Officialapplication/vnd.dev.sigstore.bundle.v0.3+json

    https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

    sha256:d1371a131371e967dcf30c0977070c94a008b7fcc9df38ed04eac3abde1a9aef

Reference at this version

oci://hub.aggrega.ai/component/core/ai-tool/retrieval:1.0.0

Developer parameters

Values the developer sets in the Aggregate.

Extends BaseComponents#/schemas/BaseToolParameter

NameTypeDefaultRequiredDescription
top_kinteger5yes—
side_effectsstring (read_only)read_onlyyes—

Operator sizing

Infrastructure sizing the operator tunes per environment.

NameTypeDefaultRequiredDescription
imagestring—noContainer image serving the lookup over HTTP.
portinteger (min 1024, max 65535)8080noPort the tool's own container listens on. A consumer does not necessarily connect here: the realization publishes the address callers use, and a control plane that fronts the tool routes from its own port to this one.
computeobject—no—
min_replicasinteger (min 0)0noReplica floor. Zero is what lets the tool run no replicas between calls, which the realization reaches through its control plane.
max_replicasinteger (min 1)5noReplica ceiling the realization's autoscaler may reach.
control_plane_presentbooleanfalsenoOperator affirmation that Knative Serving, the control plane the realization needs, is installed in the target cluster. The build halts unless this is set true, so a custom resource is never emitted as an orphan into a cluster that cannot reconcile it.
overridesobject (open)—noRealization-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Output contract

Values this component publishes to consumers over the uses topology.

NameTypeDefaultRequiredDescription
hoststring—yesIn-cluster DNS name an agent calls to fetch reference material by similarity. A consumer that composes its own address dials this name; one that does not reads `endpoint` instead.
portinteger—yesTCP port the lookup is accepted on. The realization fronts the tool on the control plane's own port rather than the tool container's, so a consumer reads this rather than the port an operator set.
endpointstring—yesFull base URL an agent posts a lookup to, with the host and the port already composed. It addresses the tool, not the datastore behind it, which the tool reaches over its own socket.
protocolstring—noURL scheme to reach `host` and `port` over, for a consumer composing its own address rather than reading `endpoint`.

Uses sockets

The dependency sockets this component connects through. The target of every connection wired through a socket must satisfy its label selector, and each connection may carry an attachment in the slots the socket declares. A required slot is owed by each connection the Aggregate or the Release wires through the socket.

target_datastore

Selector
datastore.aggrega.ai/engine in (vector, semantic-memory, search)
Inject
env, file

This socket declares no attachment slots, so a connection through it carries no attachment.

Attachment slots

Named binding points at which a Feature attaches to this component. A slot's selector constrains which Feature may fill it and its inject list names how the Feature's material may be delivered. A required slot must be bound on every instance, by an attachment on the instance or at a scope above it, and a sensitive slot is declared to handle secret material. A Feature may also attach under a name no slot declares.

No attachment slots declared.

Self-inject allowlist

env, file

Relationships

Typed edges to and from other published entities. A reference with no published target renders as a broken edge rather than a link.

Uses

Used by

Component concept reference →

The Aggrega catalog — an open index of components, features, recipes, and the plugins that render them.

Built with the shared Aggrega design system.

Privacy