ToolHints

org.llm4s.toolapi.ToolHints
See theToolHints companion class
@Experimental
object ToolHints

Factory and default for ToolHints. The defaults are the conservative MCP ones: a tool that does not say what it does is treated as not read-only, destructive, not idempotent and open-world.

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ToolHints.type

Members list

Type members

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def apply(readOnly: Boolean, destructive: Boolean, idempotent: Boolean, openWorld: Boolean): ToolHints

Creates a ToolHints. Each default assumes the less safe case, so that a middleware asking approval for tools that are not read-only does not skip a tool that never declared otherwise.

Creates a ToolHints. Each default assumes the less safe case, so that a middleware asking approval for tools that are not read-only does not skip a tool that never declared otherwise.

Value parameters

destructive

destructiveHint: the tool may perform destructive updates rather than only additive ones; meaningful only when the tool is not read-only; defaults to true, so updates are assumed destructive

idempotent

idempotentHint: calling it again with the same arguments has no further effect; meaningful only when the tool is not read-only; defaults to false, so repeating a call is assumed to have a further effect

openWorld

openWorldHint: the tool may interact with an open world of external entities, such as the web, rather than a closed domain; defaults to true, so the tool is assumed to reach external entities

readOnly

readOnlyHint: the tool does not modify its environment; defaults to false, so the tool is assumed to modify it

Attributes

Returns

the hints; they are hints, not guarantees

Concrete fields

Not read-only, destructive, not idempotent, open-world: the MCP defaults.

Not read-only, destructive, not idempotent, open-world: the MCP defaults.

Attributes