llm4s-docs
API
Generated with
llm4s-docs/org.llm4s/org.llm4s.agent/org.llm4s.agent.graph/org.llm4s.agent.graph.tool/ToolHints

ToolHints

org.llm4s.agent.graph.tool.ToolHints
See theToolHints companion object
final case class ToolHints

What a tool is likely to do, with the meanings of the MCP tool annotations and their conservative defaults. These are hints a middleware reads (for example to ask approval for a tool that is not read-only), not guarantees: nothing checks that a tool behaves as it says.

Value parameters

destructive

MCP destructiveHint: the tool may perform destructive updates rather than only additive ones; meaningful only when it is not readOnly

idempotent

MCP idempotentHint: calling it again with the same arguments has no further effect; meaningful only when it is not readOnly

openWorld

MCP openWorldHint: the tool may interact with an open world of external entities, such as the web, rather than a closed domain

readOnly

MCP readOnlyHint: the tool does not modify its environment

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def withDestructive(v: Boolean): ToolHints
def withIdempotent(v: Boolean): ToolHints
def withOpenWorld(v: Boolean): ToolHints
def withReadOnly(v: Boolean): ToolHints

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with