Documentation
¶
Overview ¶
Package agent provides strong type identifiers for agents and tools.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Bounds ¶
type Bounds struct {
Returned int
Total *int
Truncated bool
NextCursor *string
RefinementHint string
}
Bounds describes how a tool result has been bounded relative to the full underlying data set. It is a small, provider-agnostic contract used by runtimes, sinks, and services to surface truncation metadata without re-inspecting tool-specific fields.
Returned reports how many items or points are present in the bounded view. Total, when non-nil, reports the best-effort total before truncation. Truncated indicates whether any caps were applied (length, window, depth). NextCursor, when non-nil, is an opaque cursor that can be used to fetch the next page of results when Truncated is true. RefinementHint provides short, human-readable guidance on how to narrow or refine the query when Truncated is true.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api defines shared types that cross workflow/activity boundaries in the agent runtime.
|
Package api defines shared types that cross workflow/activity boundaries in the agent runtime. |
|
Package engine defines workflow engine abstractions for durable agent execution.
|
Package engine defines workflow engine abstractions for durable agent execution. |
|
inmem
Package inmem provides an in-memory workflow engine implementation for tests and local development.
|
Package inmem provides an in-memory workflow engine implementation for tests and local development. |
|
temporal
Package temporal implements the loom-mcp workflow engine adapter backed by Temporal (https://temporal.io).
|
Package temporal implements the loom-mcp workflow engine adapter backed by Temporal (https://temporal.io). |
|
Package hooks implements fan-out hooks for runtime observability and memory.
|
Package hooks implements fan-out hooks for runtime observability and memory. |
|
Package interrupt provides workflow signal handling for pausing and resuming agent runs.
|
Package interrupt provides workflow signal handling for pausing and resuming agent runs. |
|
Package memory persists event payloads as generic maps so stores can serialize them uniformly, but runtime and transcript code should interact with the typed payload structs in this file.
|
Package memory persists event payloads as generic maps so stores can serialize them uniformly, but runtime and transcript code should interact with the typed payload structs in this file. |
|
inmem
Package inmem provides an in-memory implementation of memory.Store for testing and local development.
|
Package inmem provides an in-memory implementation of memory.Store for testing and local development. |
|
Package model defines JSON helpers for marshaling and unmarshaling provider message parts.
|
Package model defines JSON helpers for marshaling and unmarshaling provider message parts. |
|
Package planner defines planner contracts and helper implementations.
|
Package planner defines planner contracts and helper implementations. |
|
Package policy codifies policy evaluation and enforcement for agent runs.
|
Package policy codifies policy evaluation and enforcement for agent runs. |
|
Package prompt contains runtime prompt registry and override resolution logic.
|
Package prompt contains runtime prompt registry and override resolution logic. |
|
Package rawjson provides a safe raw JSON byte type for workflow boundaries.
|
Package rawjson provides a safe raw JSON byte type for workflow boundaries. |
|
Package reminder defines core types for run-scoped system reminders used to provide backstage guidance to planners (safety, correctness, workflow, and context hints).
|
Package reminder defines core types for run-scoped system reminders used to provide backstage guidance to planners (safety, correctness, workflow, and context hints). |
|
Package run defines primitives for tracking agent run executions.
|
Package run defines primitives for tracking agent run executions. |
|
Package runlog provides a durable, append-only event log for agent runs.
|
Package runlog provides a durable, append-only event log for agent runs. |
|
inmem
Package inmem provides an in-memory implementation of runlog.Store.
|
Package inmem provides an in-memory implementation of runlog.Store. |
|
Package runtime emits cooperative activity heartbeats for long-running planner and tool activities so engine-driven cancellation reaches streaming provider calls promptly instead of after the activity returns on its own.
|
Package runtime emits cooperative activity heartbeats for long-running planner and tool activities so engine-driven cancellation reaches streaming provider calls promptly instead of after the activity returns on its own. |
|
hints
Package hints provides lightweight, template-based rendering helpers for tool call/result hints.
|
Package hints provides lightweight, template-based rendering helpers for tool call/result hints. |
|
Package session defines durable session lifecycle and run metadata primitives.
|
Package session defines durable session lifecycle and run metadata primitives. |
|
inmem
Package inmem provides an in-memory implementation of session.Store.
|
Package inmem provides an in-memory implementation of session.Store. |
|
Package stream provides abstractions for delivering real-time agent execution updates to clients.
|
Package stream provides abstractions for delivering real-time agent execution updates to clients. |
|
bridge
Package bridge provides a discoverable entrypoint to wire the runtime hook bus to a stream.Sink without importing the hooks subscriber directly.
|
Package bridge provides a discoverable entrypoint to wire the runtime hook bus to a stream.Sink without importing the hooks subscriber directly. |
|
Package telemetry integrates runtime events with Clue tracing and metrics.
|
Package telemetry integrates runtime events with Clue tracing and metrics. |
|
Package toolerrors provides structured error types for tool invocation failures.
|
Package toolerrors provides structured error types for tool invocation failures. |
|
Package tools defines runtime-facing tool metadata and helpers.
|
Package tools defines runtime-facing tool metadata and helpers. |
|
Package transcript provides a minimal, provider‑precise ledger that records the canonical conversation needed to rebuild provider payloads (e.g., Bedrock) without leaking provider SDK types into workflow state.
|
Package transcript provides a minimal, provider‑precise ledger that records the canonical conversation needed to rebuild provider payloads (e.g., Bedrock) without leaking provider SDK types into workflow state. |