Struct InvocableSpec 

pub struct InvocableSpec {
    pub name: CapabilityName,
    pub description: String,
    pub input_schema: Value,
    pub metadata: MetadataMap,
}

Describes an Invocable capability so it can be advertised to the model.

The spec is presented to the model alongside other available tools so that it can decide when to call the capability. The input_schema field should be a valid JSON Schema object describing the expected input shape.

Example

use agentkit_capabilities::{CapabilityName, InvocableSpec};
use serde_json::json;

let spec = InvocableSpec::new(
    CapabilityName::new("search"),
    "Search the codebase for a pattern",
    json!({
        "type": "object",
        "properties": {
            "query": { "type": "string" }
        },
        "required": ["query"]
    }),
);

assert_eq!(spec.name.as_str(), "search");

Fields

name: CapabilityName

The capability name that the model uses to reference this invocable.

description: String

A human-readable description shown to the model so it can decide when to invoke this capability.

input_schema: Value

A JSON Schema describing the expected shape of InvocableRequest::input.

metadata: MetadataMap

Arbitrary key-value metadata attached to the spec.

Implementations

impl InvocableSpec

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

Builds an invocable spec with empty metadata.

pub fn with_metadata(self, metadata: MetadataMap) -> Self

Replaces the spec metadata.

Trait Implementations

impl Clone for InvocableSpec

fn clone(&self) -> InvocableSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InvocableSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InvocableSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for InvocableSpec

fn eq(&self, other: &InvocableSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for InvocableSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InvocableSpec