For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • About NVIDIA NeMo Relay
    • Overview
    • Architecture
    • Ecosystem
    • Concepts
    • Release Notes
  • Getting Started
    • Agent Runtime Primer
    • Prerequisites
    • Installation
    • Configuration / Setup
    • Quick Start
  • NVIDIA NeMo Relay CLI
    • About
    • Basic Usage
    • Claude Code
    • Codex
    • Cursor
    • Hermes Agent
  • Supported Integrations
    • About
    • OpenClaw Plugin Guide
    • LangChain Integration Guide
    • LangGraph Integration Guide
    • Deep Agents Integration Guide
  • Instrument Applications
    • About
    • Adding Scopes and Marks
    • Instrument a Tool Call
    • Instrument an LLM Call
    • Add Middleware
    • Code Examples
  • Observability Plugin
    • About
    • Configuration
    • Agent Trajectory Interchange Format (ATIF)
    • Agent Trajectory Observability Format (ATOF)
    • OpenTelemetry
    • OpenInference
  • Adaptive Plugin
    • About
    • Configuration
    • Adaptive Cache Governor (ACG)
    • Adaptive Hints
  • NeMo Guardrails Plugin
    • About
    • Configuration
  • Integrate into Frameworks
    • About
    • Adding Scopes
    • Wrap Tool Calls
    • Wrap LLM Calls
    • Handle Non-Serializable Data
    • Using Codecs
    • Provider Codecs
    • Provider Response Codecs
    • Code Examples
  • Build Plugins
    • About
    • Define a Plugin
    • Validate Plugin Configuration
    • Plugin Configuration Files
    • Register Plugin Behavior
    • Design Plugin Configuration
    • NeMo Guardrails Example Plugin
    • Code Examples
  • Contribute
    • About
    • Development Setup
    • Workflow and Reviews
    • Testing and Documentation
  • Reference
    • APIs
      • Python Library Reference
      • Node.js Library Reference
      • Rust Library Reference
        • nemo-relay
          • api
            • event
            • llm
            • registry
            • runtime
            • scope
            • subscriber
            • tool
              • CreateToolHandleParams
              • EndToolHandleParams
              • ToolAttributes
              • ToolCallEndParams
              • ToolCallExecuteParams
              • ToolCallParams
              • ToolHandle
              • tool_call
              • tool_call_end
              • tool_call_execute
              • tool_conditional_execution
              • tool_request_intercepts
          • codec
          • config_editor
          • error
          • json
          • observability
          • plugin
          • plugins
          • stream
          • editor_config
        • nemo-relay-adaptive
        • nemo-relay-ffi
    • Performance
  • Resources
    • Support and FAQs
    • Glossary
    • Troubleshooting Guide
    • Community
    • Legal
NVIDIANVIDIA
Developer-friendly docs for your API
Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2026, NVIDIA Corporation.

LogoLogo
On this page
  • Fields
  • uuid: Uuid
  • started_at: DateTime<Utc>
  • name: String
  • data: Option<Json>
  • metadata: Option<Json>
  • attributes: ToolAttributes
  • parent_uuid: Option<Uuid>
  • tool_call_id: Option<String>
  • Implementations
  • impl ToolHandle
  • builder
  • Trait Implementations
  • impl Clone for ToolHandle
  • clone
  • clone_from
  • impl Debug for ToolHandle
  • fmt
  • impl<'de> Deserialize<'de> for ToolHandle
  • deserialize
  • impl Serialize for ToolHandle
  • serialize
ReferenceAPIsRust Library Referencenemo-relayapitool

Struct Tool Handle

||View as Markdown|
Previous

Struct Tool Call Params

Next

Function tool_call

Generated from cargo doc --no-deps -p nemo-relay -p nemo-relay-adaptive -p nemo-relay-ffi.

pub struct ToolHandle {
    pub uuid: Uuid,
    pub started_at: DateTime<Utc>,
    pub name: String,
    pub data: Option<Json>,
    pub metadata: Option<Json>,
    pub attributes: ToolAttributes,
    pub parent_uuid: Option<Uuid>,
    pub tool_call_id: Option<String>,
}

Runtime-owned handle identifying an active or completed tool call.

Fields

uuid: Uuid

Unique tool-call identifier.

started_at: DateTime<Utc>

Timestamp captured when the tool handle was created.

name: String

Tool name recorded on lifecycle events.

data: Option<Json>

Optional application payload stored on the handle.

metadata: Option<Json>

Optional metadata attached to the tool span.

attributes: ToolAttributes

Tool behavior flags.

parent_uuid: Option<Uuid>

UUID of the parent scope, if any.

tool_call_id: Option<String>

Optional provider-specific tool-call correlation identifier.

Implementations

impl ToolHandle

impl ToolHandle

builder

pub fn builder() -> ToolHandleBuilder<((), (), (), (), (), (), (), ())>

Create a builder for building ToolHandle. On the builder, call .uuid(...)(optional), .started_at(...)(optional), .name(...), .data(...)(optional), .metadata(...)(optional), .attributes(...)(optional), .parent_uuid(...)(optional), .tool_call_id(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of ToolHandle.

Trait Implementations

impl Clone for ToolHandle

impl Clone for ToolHandle

clone

fn clone(&self) -> ToolHandle

clone_from

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

impl Debug for ToolHandle

impl Debug for ToolHandle

fmt

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

impl<'de> Deserialize<'de> for ToolHandle

impl<'de> Deserialize<'de> for ToolHandle

deserialize

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

impl Serialize for ToolHandle

impl Serialize for ToolHandle

serialize

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