Enum ToolDocumentationMode 

pub enum ToolDocumentationMode {
    Minimal,
    Progressive,
    Full,
}

Tool documentation mode (inspired by pi-coding-agent progressive disclosure) Controls how much tool documentation is loaded upfront vs on-demand

Variants

Minimal

First sentence of each tool description (at most 64 chars) and no parameter descriptions - Pi-style, power users Best for: Maximum efficiency, experienced users, token-constrained contexts

Progressive

Complete tool and parameter descriptions; only unusually long tails are trimmed at a sentence boundary (measured ~1,793 tokens for the default catalog; budgeted ≤ 2,000 in emitted_model_tool_schema_fits_within_first_request_budget) Best for: General usage (recommended)

Full

Every tool and parameter description sent unmodified Best for: Debugging tool definitions, comprehensive documentation

Implementations

impl ToolDocumentationMode

pub fn allowed_values() -> &'static [&'static str]

Allowed configuration values for validation

Trait Implementations

impl Clone for ToolDocumentationMode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ToolDocumentationMode

impl Debug for ToolDocumentationMode

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

Formats the value using the given formatter.

impl Default for ToolDocumentationMode

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolDocumentationMode

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ToolDocumentationMode

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

Formats the value using the given formatter.

impl Eq for ToolDocumentationMode

impl JsonSchema for ToolDocumentationMode

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ToolDocumentationMode

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolDocumentationMode

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 ToolDocumentationMode