Skip to main content

dynamo_renderer/
response_tools.rs

1// SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES.
2// SPDX-License-Identifier: Apache-2.0
3
4use dynamo_protocols::types::responses::{
5    NamespaceToolParamTool, RequestTool, Tool, ToolSearchExecutionType, ToolSearchToolParam,
6};
7use serde_json::{Value, json};
8
9pub use dynamo_protocols::types::{CUSTOM_TOOL_INPUT_ARG, custom_tool_parameters};
10
11/// Function view for the client-owned search operation. Hosted search is not rendered.
12pub fn client_tool_search_function(search: &ToolSearchToolParam) -> Option<Value> {
13    (search.execution == Some(ToolSearchExecutionType::Client)).then(|| {
14        json!({"type":"function", "function": {
15            "name":"tool_search", "description":search.description.as_deref().unwrap_or("Search for tools and return their full definitions."),
16            "parameters":search.parameters.clone().unwrap_or_else(|| json!({"type":"object","properties":{"query":{"type":"string"}},"required":["query"],"additionalProperties":false}))
17        }})
18    })
19}
20
21fn function(
22    name: &str,
23    description: Option<&str>,
24    parameters: Option<&Value>,
25    defer: Option<bool>,
26) -> Value {
27    let mut value = json!({"name":name, "description":description.unwrap_or(""),
28        "parameters":parameters.cloned().unwrap_or_else(|| json!({"type":"object","properties":{}}))});
29    if let Some(flag) = defer {
30        value["defer_loading"] = Value::Bool(flag);
31    }
32    value
33}
34
35/// Native structures for templates that understand namespaces and deferral.
36/// Hosted tools remain outside the function-template rendering surface.
37pub fn native_tools_for_chat_template(tools: &[RequestTool]) -> Vec<Value> {
38    tools.iter().filter_map(|tool| match &tool.inner {
39        Tool::Function(f) => Some(json!({"type":"function", "function":
40            function(&f.name, f.description.as_deref(), f.parameters.as_ref(), f.defer_loading)})),
41        Tool::Custom(f) => Some(json!({"type":"function", "function":
42            function(&f.name, f.description.as_deref(), Some(&custom_tool_parameters()), f.defer_loading)})),
43        Tool::Namespace(ns) => {
44            let members: Vec<_> = ns.tools.iter().map(|member| match member {
45                NamespaceToolParamTool::Function(f) => function(&f.name,
46                    f.description.as_deref().filter(|description| !description.is_empty()).or(Some(ns.description.as_str())), f.parameters.as_ref(), f.defer_loading),
47                NamespaceToolParamTool::Custom(f) => function(&f.name,
48                    f.description.as_deref().filter(|description| !description.is_empty()).or(Some(ns.description.as_str())), Some(&custom_tool_parameters()), f.defer_loading),
49            }).collect();
50            let mut value = json!({"type":"namespace", "name":ns.name, "description":ns.description, "tools":members});
51            if let Some(flag) = tool.namespace_defer_loading { value["defer_loading"] = Value::Bool(flag); }
52            Some(value)
53        }
54        Tool::ToolSearch(search) => client_tool_search_function(search),
55        _ => None,
56    }).collect()
57}
58
59#[cfg(test)]
60mod tests {
61    use super::*;
62    #[test]
63    fn native_members_preserve_inheritance_and_custom_input_schema() {
64        let tools: Vec<RequestTool> = serde_json::from_value(json!([{
65            "type":"namespace","name":"fs","description":"Files","defer_loading":true,"tools":[
66                {"type":"function","name":"read"},
67                {"type":"function","name":"write","defer_loading":false},
68                {"type":"custom","name":"patch","description":null,"format":{"type":"text"},"defer_loading":true}
69            ]
70        }])).unwrap();
71        let native = native_tools_for_chat_template(&tools);
72        assert_eq!(native[0]["defer_loading"], true);
73        assert!(native[0]["tools"][0].get("defer_loading").is_none());
74        assert_eq!(native[0]["tools"][1]["defer_loading"], false);
75        assert_eq!(
76            native[0]["tools"][2]["parameters"]["required"],
77            json!([CUSTOM_TOOL_INPUT_ARG])
78        );
79        assert_eq!(native[0]["tools"][0]["name"], "read");
80    }
81}