Component
core/ai-tool/openapi
A tool built from an API's own description: the developer supplies the location of an OpenAPI document, and the operations that document declares become what the agent may call. An Aggregate adds a whole HTTP API to an agent by pointing at its specification, rather than declaring one tool per endpoint. Marked mutating, since the described operations may include ones that write. 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. An edge from the tool, on a socket the author names, delivers what its `inject:` block dictates, as variables or as files, on every realization that runs the tool. The catalog pins no image, so nothing renders until the Release sets `infra.image`. 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.
Provenance
- Content digest
- sha256:6158f471063ec2a782653af1c221663457e27c4d3a1580535d5316db5196d41e
- Published
- 2026-11-10T10:10:03Z
- 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:50d87cb81c3b1d52bce7f7135da64cc7de899846e5bce062a4b10e64d10a1878
Reference at this version
oci://hub.aggrega.ai/component/core/ai-tool/openapi:1.0.0Developer parameters
Values the developer sets in the Aggregate.
Extends BaseComponents#/schemas/BaseToolParameter
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| spec_uri | string | — | yes | — |
Operator sizing
Infrastructure sizing the operator tunes per environment.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| image | string | — | no | Container image serving the tool over HTTP. |
| port | integer (min 1024, max 65535) | 8080 | no | Port 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. |
| compute | object | — | no | — |
| min_replicas | integer (min 0) | 0 | no | Replica floor. Zero is what lets the tool run no replicas between the calls that invoke it, which the realization reaches through its control plane. |
| max_replicas | integer (min 1) | 5 | no | Replica ceiling the realization's autoscaler may reach. |
| control_plane_present | boolean | false | no | Operator 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. |
| overrides | object (open) | — | no | Realization-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.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| host | string | — | yes | In-cluster DNS name an agent calls to reach the described API through this tool. A consumer that composes its own address dials this name; one that does not reads `endpoint` instead. |
| port | integer | — | yes | TCP port the tool accepts an agent's calls 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. |
| endpoint | string | — | yes | Full base URL an agent calls the tool at, with the host and the port already composed. It addresses the tool, not the API the specification describes, which the tool reaches on the agent's behalf. |
| protocol | string | — | no | URL 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.
No uses sockets declared.
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
- $refextends schema (values)
BaseComponents#/schemas/BaseToolParameter
Used by
applies to
implements