Struct ToolDefinition 

pub struct ToolDefinition {
    pub name: ToolName,
    pub description: String,
    pub parameters: Value,
    pub output_schema: Option<Value>,
}

Minimal tool definition passed to LLM providers.

Decoupled from zeph-tools::ToolDef to avoid cross-crate dependencies. Providers translate this into their native tool/function format before sending to the API.

Examples

use zeph_common::types::ToolDefinition;
use zeph_common::ToolName;

let tool = ToolDefinition {
    name: ToolName::new("get_weather"),
    description: "Return current weather for a city.".into(),
    parameters: serde_json::json!({
        "type": "object",
        "properties": {
            "city": { "type": "string" }
        },
        "required": ["city"]
    }),
    output_schema: None,
};
assert_eq!(tool.name, "get_weather");

Fields

name: ToolName

Tool name — must match the name used in the response ToolUseRequest.

description: String

Human-readable description guiding the model on when to call this tool.

parameters: Value

JSON Schema object describing parameters.

output_schema: Option<Value>

Raw output schema advertised by the MCP server, if present.

When mcp.forward_output_schema = true, LLM provider assemblers append a compact JSON hint to the tool description rather than adding a new top-level field (unsupported by the Anthropic and OpenAI APIs).

DO NOT convert to schemars::Schema — lossy; see #2931 critique P0-1.

Trait Implementations

impl Clone for ToolDefinition

fn clone(&self) -> ToolDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolDefinition

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

Formats the value using the given formatter.

impl Default for ToolDefinition

fn default() -> ToolDefinition

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.