Struct Definition 

pub struct Definition { /* private fields */ }

A reusable code-defined capability.

A definition is an immutable value: clone it to install the same capability on several agents. The consuming host registers it privately when the agent’s session starts; capability authors never manipulate an engine registry.

Implementations

impl Definition

pub fn new( id: impl Into<String>, name: impl Into<String>, description: impl Into<String>, ) -> Self

Start a capability definition.

id is the stable persisted identifier. name and description are human-facing catalog text. These values, tool names, and tool input schemas are validated by the consuming boundary (e.g. the Framework’s AgentBuilder::build).

pub fn instructions(self, instructions: impl Into<String>) -> Self

Add capability-level behavioral guidance to the agent’s system prompt.

Do not repeat facts already expressed by tool names, descriptions, or schemas. Use this for cross-tool ordering, constraints, and semantics.

pub fn metadata(self, metadata: impl Into<Value>) -> Self

Attach host-owned, JSON metadata for catalogs and embedding hosts.

The engine does not interpret this value. It may be persisted or shown to clients, so it must never contain credentials or sensitive payloads.

pub fn tool<H>(self, handler: H) -> Self

where H: Handler,

Add one typed tool handler.

pub fn id(&self) -> &str

The stable capability identifier.

pub fn name(&self) -> &str

The human-readable capability name.

pub fn description(&self) -> &str

The capability description.

pub fn instructions_text(&self) -> Option<&str>

Capability-level instructions, when configured.

pub fn metadata_value(&self) -> Option<&Value>

Host-owned capability metadata, when configured.

pub fn tools(&self) -> &[Tool]

Typed tool descriptors in registration order.

pub fn validate(&self) -> Result<(), CapabilityError>

Validate the definition’s identity and structural rules.

Trait Implementations

impl Clone for Definition

fn clone(&self) -> Definition

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Definition

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

Formats the value using the given formatter.

impl From<Definition> for CapabilitySpec

Available on crate feature definition only.

fn from(definition: Definition) -> Self

Converts to this type from the input type.

impl IntoCapability for Definition

Available on crate feature definition only.

fn into_capability(self) -> CapabilitySpec

Consume the value and return its normalized specification.