Index (mc-agent-tool-spi 0.0.3 API)

A B C D E F G H I K M N O P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values

A

agentDefinitionId() - Method in record class ai.mindconnect.agent.tool.AgentTool: Returns the value of the agentDefinitionId record component.
agentDefinitionId() - Method in record class ai.mindconnect.agent.tool.ToolAdvisor.Invocation: Returns the value of the agentDefinitionId record component.
agentDefinitionId() - Method in record class ai.mindconnect.agent.tool.ToolCallScope: Returns the value of the agentDefinitionId record component.
AgentTool - Record Class in ai.mindconnect.agent.tool: Reference from an AgentDefinition to a tool the agent is allowed to use.
AgentTool(UUID, UUID, String, String, Map<String, Object>, boolean) - Constructor for record class ai.mindconnect.agent.tool.AgentTool: Pre-deferred-flag constructor: tool is always offered (deferred = false).
AgentTool(UUID, UUID, String, String, Map<String, Object>, boolean, boolean) - Constructor for record class ai.mindconnect.agent.tool.AgentTool: Pre-needsApproval constructor: the tool runs unasked.
AgentTool(UUID, UUID, String, String, Map<String, Object>, boolean, boolean, boolean) - Constructor for record class ai.mindconnect.agent.tool.AgentTool: Pre-maxResultChars constructor: no per-tool result cap.
AgentTool(UUID, UUID, String, String, Map<String, Object>, boolean, boolean, boolean, Integer) - Constructor for record class ai.mindconnect.agent.tool.AgentTool: Creates an instance of a AgentTool record class.
ai.mindconnect.agent.tool - package ai.mindconnect.agent.tool
AliasTool - Class in ai.mindconnect.agent.tool: Lets an agent expose a registry tool under its own name.
append(String) - Method in record class ai.mindconnect.agent.tool.ToolAdvisor.Result: Returns a copy with extra appended after a blank line.
applies(ToolAdvisor.Invocation) - Method in interface ai.mindconnect.agent.tool.ToolAdvisor: Per-call opt-out.
arguments() - Method in record class ai.mindconnect.agent.tool.ToolAdvisor.Invocation: Returns the value of the arguments record component.
around(ToolAdvisor.Invocation, ToolAdvisor.Chain) - Method in interface ai.mindconnect.agent.tool.ToolAdvisor: Wraps one tool invocation.

B

bind(ToolEnvironment) - Method in interface ai.mindconnect.agent.tool.MultiToolProvider: Optional capture of runtime dependencies; default is a no-op.
bind(ToolEnvironment) - Method in interface ai.mindconnect.agent.tool.ToolFactory: Called once after construction to wire the factory against the runtime environment.
build() - Method in class ai.mindconnect.agent.tool.MapToolEnvironment.Builder
builder() - Static method in class ai.mindconnect.agent.tool.MapToolEnvironment
Builder() - Constructor for class ai.mindconnect.agent.tool.MapToolEnvironment.Builder

C

create(AgentTool, ToolCallScope) - Method in interface ai.mindconnect.agent.tool.ToolFactory: Build a tool for the given configuration and call scope.
create(String, AgentTool, ToolCallScope) - Method in interface ai.mindconnect.agent.tool.MultiToolProvider: Build a tool for the given name.

D

deferred() - Method in record class ai.mindconnect.agent.tool.AgentTool: Returns the value of the deferred record component.
description() - Method in record class ai.mindconnect.agent.tool.AgentTool: Returns the value of the description record component.
description() - Method in class ai.mindconnect.agent.tool.AliasTool
description() - Method in class ai.mindconnect.agent.tool.PinnedParamsTool
description() - Method in interface ai.mindconnect.agent.tool.Tool

E

enabled() - Method in record class ai.mindconnect.agent.tool.AgentTool: Returns the value of the enabled record component.
equals(Object) - Method in record class ai.mindconnect.agent.tool.AgentTool: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class ai.mindconnect.agent.tool.ToolAdvisor.Invocation: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class ai.mindconnect.agent.tool.ToolAdvisor.Result: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class ai.mindconnect.agent.tool.ToolCallScope: Indicates whether some other object is "equal to" this one.
error(String) - Static method in record class ai.mindconnect.agent.tool.ToolAdvisor.Result
execute(Map<String, Object>) - Method in class ai.mindconnect.agent.tool.AliasTool
execute(Map<String, Object>) - Method in class ai.mindconnect.agent.tool.PinnedParamsTool
execute(Map<String, Object>) - Method in interface ai.mindconnect.agent.tool.Tool

F

failed() - Method in record class ai.mindconnect.agent.tool.ToolAdvisor.Result: Returns the value of the failed record component.

G

get() - Method in class ai.mindconnect.agent.tool.ToolRegistryRef
get(Class<T>) - Method in class ai.mindconnect.agent.tool.MapToolEnvironment
get(Class<T>) - Method in interface ai.mindconnect.agent.tool.ToolEnvironment: Look up a service by type.
getString(String) - Method in class ai.mindconnect.agent.tool.MapToolEnvironment
getString(String) - Method in interface ai.mindconnect.agent.tool.ToolEnvironment: Look up a named string value (e.g. an API key or base directory).
group() - Method in interface ai.mindconnect.agent.tool.MultiToolProvider: The provider's group — both the rubric under which its tools appear in catalogs/pickers and the machine namespace its tool names live in: by convention a provider's tool names compose as group() + "_" + localName (group "workflow", workflow "pipeline" → tool "workflow_pipeline"; group "gmail" → "gmail_search_messages").
group() - Method in interface ai.mindconnect.agent.tool.ToolFactory: Rubric under which this tool is shown in catalogs and pickers (e.g.

H

hashCode() - Method in record class ai.mindconnect.agent.tool.AgentTool: Returns a hash code value for this object.
hashCode() - Method in record class ai.mindconnect.agent.tool.ToolAdvisor.Invocation: Returns a hash code value for this object.
hashCode() - Method in record class ai.mindconnect.agent.tool.ToolAdvisor.Result: Returns a hash code value for this object.
hashCode() - Method in record class ai.mindconnect.agent.tool.ToolCallScope: Returns a hash code value for this object.

I

id() - Method in record class ai.mindconnect.agent.tool.AgentTool: Returns the value of the id record component.
Invocation(String, Map<String, Object>, Namespace, String, UUID, UUID, String) - Constructor for record class ai.mindconnect.agent.tool.ToolAdvisor.Invocation: Creates an instance of a Invocation record class.
isAvailable() - Method in interface ai.mindconnect.agent.tool.MultiToolProvider: False disables the entire bundle — neither MultiToolProvider.toolNames() nor MultiToolProvider.create(java.lang.String, ai.mindconnect.agent.tool.AgentTool, ai.mindconnect.agent.tool.ToolCallScope) will be honored by the registry.
isAvailable() - Method in interface ai.mindconnect.agent.tool.ToolFactory: Whether this factory has everything it needs to produce a working tool.

K

knownToolNames() - Method in class ai.mindconnect.agent.tool.SpiToolRegistry
knownToolNames() - Method in interface ai.mindconnect.agent.tool.ToolRegistry: Names of all tools known to this registry.

M

MapToolEnvironment - Class in ai.mindconnect.agent.tool: Mutable, builder-style ToolEnvironment backed by two maps: one for typed services and one for named string values.
MapToolEnvironment.Builder - Class in ai.mindconnect.agent.tool
maxResultChars() - Method in record class ai.mindconnect.agent.tool.AgentTool: Returns the value of the maxResultChars record component.
MultiToolProvider - Interface in ai.mindconnect.agent.tool: SPI for tool sources that contribute multiple tool names from a single registration — complement to ToolFactory (which is strictly 1:1 with a name).

N

name() - Method in record class ai.mindconnect.agent.tool.AgentTool: Returns the value of the name record component.
name() - Method in class ai.mindconnect.agent.tool.AliasTool
name() - Method in class ai.mindconnect.agent.tool.PinnedParamsTool
name() - Method in interface ai.mindconnect.agent.tool.Tool
name() - Method in interface ai.mindconnect.agent.tool.ToolFactory: Unique tool name this factory produces (e.g.
namespace() - Method in record class ai.mindconnect.agent.tool.ToolAdvisor.Invocation: Returns the value of the namespace record component.
namespace() - Method in record class ai.mindconnect.agent.tool.ToolCallScope: Returns the value of the namespace record component.
needsApproval() - Method in record class ai.mindconnect.agent.tool.AgentTool: Returns the value of the needsApproval record component.

O

#overrides() - Search tag in record class ai.mindconnect.agent.tool.AgentTool: Section
of(UUID, String) - Static method in record class ai.mindconnect.agent.tool.AgentTool: Minimal reference: just a tool name, no overrides, enabled.
of(UUID, String, String) - Static method in record class ai.mindconnect.agent.tool.AgentTool: Reference with a human-readable description but no overrides.
of(UUID, String, String, Map<String, Object>) - Static method in record class ai.mindconnect.agent.tool.AgentTool: Reference with agent-level overrides (e.g.
ok(String) - Static method in record class ai.mindconnect.agent.tool.ToolAdvisor.Result
order() - Method in interface ai.mindconnect.agent.tool.ToolAdvisor: Lower runs further out — sees raw input and final output.
OVERRIDE_KEY - Static variable in class ai.mindconnect.agent.tool.AliasTool: Override key naming the registry tool to resolve instead of the agent-tool name.
OVERRIDE_KEY - Static variable in class ai.mindconnect.agent.tool.PinnedParamsTool: Key inside AgentTool.overrides() holding the pinned map.
overrides() - Method in record class ai.mindconnect.agent.tool.AgentTool: Returns the value of the overrides record component.
overridesSchema() - Method in interface ai.mindconnect.agent.tool.ToolFactory: JSON-Schema-shaped description of the config overrides this tool understands in AgentTool.overrides() — operator-level settings the LLM never sees (e.g.
overridesSchema(String) - Method in class ai.mindconnect.agent.tool.SpiToolRegistry
overridesSchema(String) - Method in interface ai.mindconnect.agent.tool.ToolRegistry: The config-overrides schema a tool declares (ToolFactory.overridesSchema()), so admin UIs can show which override keys a tool supports.

P

parametersSchema() - Method in class ai.mindconnect.agent.tool.AliasTool
parametersSchema() - Method in class ai.mindconnect.agent.tool.PinnedParamsTool
parametersSchema() - Method in interface ai.mindconnect.agent.tool.Tool
PinnedParamsTool - Class in ai.mindconnect.agent.tool: Enforces agent-pinned tool parameters.
proceed(ToolAdvisor.Invocation) - Method in interface ai.mindconnect.agent.tool.ToolAdvisor.Chain

R

registryName(AgentTool) - Static method in class ai.mindconnect.agent.tool.AliasTool: The registry name to resolve for this agent tool: alias target, else the tool's own name.
require(Class<T>) - Method in interface ai.mindconnect.agent.tool.ToolEnvironment: Required-type accessor; throws if no service of the given type is registered.
requireString(String) - Method in interface ai.mindconnect.agent.tool.ToolEnvironment: Required-string accessor; throws if no value is bound for the key.
resolve(AgentTool, Namespace, String, UUID) - Method in class ai.mindconnect.agent.tool.SpiToolRegistry
resolve(AgentTool, Namespace, String, UUID) - Method in interface ai.mindconnect.agent.tool.ToolRegistry
resolveAll(List<AgentTool>, Namespace, String, UUID) - Method in interface ai.mindconnect.agent.tool.ToolRegistry
Result(String, boolean) - Constructor for record class ai.mindconnect.agent.tool.ToolAdvisor.Result: Creates an instance of a Result record class.

S

service(Class<T>, T) - Method in class ai.mindconnect.agent.tool.MapToolEnvironment.Builder
serviceIfPresent(Class<?>, Object) - Method in class ai.mindconnect.agent.tool.MapToolEnvironment.Builder
sessionId() - Method in record class ai.mindconnect.agent.tool.ToolAdvisor.Invocation: Returns the value of the sessionId record component.
sessionId() - Method in record class ai.mindconnect.agent.tool.ToolCallScope: Returns the value of the sessionId record component.
set(ToolRegistry) - Method in class ai.mindconnect.agent.tool.ToolRegistryRef
SpiToolRegistry - Class in ai.mindconnect.agent.tool: ToolRegistry that discovers tool sources from the classpath via ServiceLoader.
SpiToolRegistry(ToolEnvironment) - Constructor for class ai.mindconnect.agent.tool.SpiToolRegistry
SpiToolRegistry(ToolEnvironment, ClassLoader) - Constructor for class ai.mindconnect.agent.tool.SpiToolRegistry
streamsResultToUser() - Method in class ai.mindconnect.agent.tool.AliasTool
streamsResultToUser() - Method in class ai.mindconnect.agent.tool.PinnedParamsTool
streamsResultToUser() - Method in interface ai.mindconnect.agent.tool.Tool: If true, the tool result is streamed directly to the user before the LLM sees it.
string(String, String) - Method in class ai.mindconnect.agent.tool.MapToolEnvironment.Builder

T

text() - Method in record class ai.mindconnect.agent.tool.ToolAdvisor.Result: Returns the value of the text record component.
Tool - Interface in ai.mindconnect.agent.tool
ToolAdvisor - Interface in ai.mindconnect.agent.tool: Filter chain around every tool invocation.
ToolAdvisor.Chain - Interface in ai.mindconnect.agent.tool: Continuation handle.
ToolAdvisor.Invocation - Record Class in ai.mindconnect.agent.tool: Everything the runtime knows about one tool call.
ToolAdvisor.Result - Record Class in ai.mindconnect.agent.tool: What the LLM ends up seeing.
toolCallId() - Method in record class ai.mindconnect.agent.tool.ToolAdvisor.Invocation: Returns the value of the toolCallId record component.
ToolCallScope - Record Class in ai.mindconnect.agent.tool: Per-invocation context passed to a ToolFactory when resolving a concrete Tool for one agent call.
ToolCallScope(Namespace, String, UUID, UUID) - Constructor for record class ai.mindconnect.agent.tool.ToolCallScope: Creates an instance of a ToolCallScope record class.
ToolEnvironment - Interface in ai.mindconnect.agent.tool: Typed registry of runtime-level dependencies that ToolFactory instances may request at bind time.
ToolFactory - Interface in ai.mindconnect.agent.tool: SPI for contributing a single built-in tool to the agent runtime.
toolName() - Method in record class ai.mindconnect.agent.tool.ToolAdvisor.Invocation: Returns the value of the toolName record component.
toolNames() - Method in interface ai.mindconnect.agent.tool.MultiToolProvider: Tool names this provider serves right now.
toolNamesByGroup() - Method in class ai.mindconnect.agent.tool.SpiToolRegistry
toolNamesByGroup() - Method in interface ai.mindconnect.agent.tool.ToolRegistry: Every resolvable tool name, grouped by its rubric (ToolFactory.group() / MultiToolProvider.group()) — for catalogs and pickers that present tools by category (agent functions, web tools, document tools, …).
ToolRegistry - Interface in ai.mindconnect.agent.tool
ToolRegistryRef - Class in ai.mindconnect.agent.tool: Late-bound handle to the ToolRegistry, breaking the construction cycle for tools that need the registry itself: SpiToolRegistry builds its factories from the ToolEnvironment, so the registry cannot be a direct environment service.
ToolRegistryRef() - Constructor for class ai.mindconnect.agent.tool.ToolRegistryRef
toString() - Method in record class ai.mindconnect.agent.tool.AgentTool: Returns a string representation of this record class.
toString() - Method in record class ai.mindconnect.agent.tool.ToolAdvisor.Invocation: Returns a string representation of this record class.
toString() - Method in record class ai.mindconnect.agent.tool.ToolAdvisor.Result: Returns a string representation of this record class.
toString() - Method in record class ai.mindconnect.agent.tool.ToolCallScope: Returns a string representation of this record class.

U

userId() - Method in record class ai.mindconnect.agent.tool.ToolAdvisor.Invocation: Returns the value of the userId record component.
userId() - Method in record class ai.mindconnect.agent.tool.ToolCallScope: Returns the value of the userId record component.

W

withArguments(Map<String, Object>) - Method in record class ai.mindconnect.agent.tool.ToolAdvisor.Invocation: Returns a copy with the supplied argument map.
withText(String) - Method in record class ai.mindconnect.agent.tool.ToolAdvisor.Result: Returns a copy with the result text replaced.
wrap(AgentTool, Tool) - Static method in class ai.mindconnect.agent.tool.AliasTool: Wraps delegate under the agent tool's name when aliased; identity otherwise.
wrap(AgentTool, Tool) - Static method in class ai.mindconnect.agent.tool.PinnedParamsTool: Wraps delegate when the agent tool pins parameters; identity otherwise.

A B C D E F G H I K M N O P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values