Package org.openqa.selenium.devtools.v147.webmcp.model

Class Tool

java.lang.Object

org.openqa.selenium.devtools.v147.webmcp.model.Tool

public class Tool
extends Object

Definition of a tool that can be invoked.

Constructor Summary

Constructors

Constructor	Description
Tool(String name, String description, Optional<Map<String,Object>> inputSchema, Optional<Annotation> annotations, FrameId frameId, Optional<BackendNodeId> backendNodeId, Optional<StackTrace> stackTrace)

Method Summary

Modifier and Type	Method	Description
Optional<Annotation>	getAnnotations()	Optional annotations for the tool.
Optional<BackendNodeId>	getBackendNodeId()	Optional node ID for declarative tools.
String	getDescription()	Tool description.
FrameId	getFrameId()	Frame identifier associated with the tool registration.
Optional<Map<String,Object>>	getInputSchema()	Schema for the tool's input parameters.
String	getName()	Tool name.
Optional<StackTrace>	getStackTrace()	The stack trace at the time of the registration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Tool

public Tool(String name,
 String description,
 Optional<Map<String,Object>> inputSchema,
 Optional<Annotation> annotations,
 FrameId frameId,
 Optional<BackendNodeId> backendNodeId,
 Optional<StackTrace> stackTrace)

Method Details

getName

public String getName()

Tool name.

getDescription

public String getDescription()

Tool description.

getInputSchema

public Optional<Map<String,Object>> getInputSchema()

Schema for the tool's input parameters.

getAnnotations

public Optional<Annotation> getAnnotations()

Optional annotations for the tool.

getFrameId

public FrameId getFrameId()

Frame identifier associated with the tool registration.

getBackendNodeId

public Optional<BackendNodeId> getBackendNodeId()

Optional node ID for declarative tools.

getStackTrace

public Optional<StackTrace> getStackTrace()

The stack trace at the time of the registration.