Struct ToolDefinition 

pub struct ToolDefinition {
    pub name: String,
    pub description: String,
    pub parameters: Value,
}

工具定义 — 发送给 LLM 的 schema。

对应 LLM API 中 tools 数组的每个元素，包含名称、描述和参数 JSON Schema。 LLM 据此决定何时调用工具以及如何构造参数。

Examples

use katu_core::ToolDefinition;
use serde_json::json;

let tool = ToolDefinition::new(
    "read_file",
    "Read the contents of a file at the given path",
    json!({
        "type": "object",
        "properties": {
            "path": { "type": "string", "description": "File path" }
        },
        "required": ["path"]
    }),
);
assert_eq!(tool.name, "read_file");

Fields

name: String

工具名称 — LLM 在 tool_call 中引用的唯一标识。

命名约定：snake_case，如 "read_file", "bash", "web_search"。

description: String

工具描述 — LLM 据此决定何时以及为什么调用此工具。

应该清晰描述工具的功能、适用场景和限制。

parameters: Value

参数的 JSON Schema — 定义工具接受的输入格式。

必须是一个 {"type": "object", "properties": {...}} 形式的 JSON Schema。 LLM 根据此 schema 构造 tool_call.arguments。

Implementations

impl ToolDefinition

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

创建新的工具定义。

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

创建无参数的工具定义。

等价于 parameters: {"type": "object", "properties": {}}。

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<'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 PartialEq for ToolDefinition

fn eq(&self, other: &ToolDefinition) -> 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 ToolDefinition

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 ToolDefinition