AS AgentScopeAPI 手册 / API Reference
包package io.agentscope.core.tool

io.agentscope.core.tool

package io.agentscope.core.tool

io.agentscope.core.tool 属于工具与技能,工具注册、schema 与执行。 该包共收录 35 个公开类型。

io.agentscope.core.tool belongs to the Tools & skills layer and contains 35 public types.

所属构件Artifacts agentscope-core

接口Interfaces

类型Type种类Kind说明Description
AgentTool接口interface
定义智能体工具契约的接口。
Interface for agent tools that can be called by models.
ContextStore接口interface
定义上下文存储契约的接口。
Storage layer abstraction for tool execution context.
ExtendedModel接口interface
定义 Extended 模型契约的接口。
Interface for extended model that adds properties to tool parameters.
ToolEmitter接口interface
定义工具 Emitter契约的接口。
Interface for emitting streaming responses during tool execution.
ToolExecutionContextProvider接口interface
定义工具执行上下文提供者契约的接口。
@deprecated Part of the {@link ToolExecutionContext} layer which is superseded by {@link io.agentscope.core.agent.RuntimeContext}.
ToolResultConverter接口interface
定义工具结果转换器契约的接口。
Converts tool method return values to ToolResultBlock.

类Classes

类型Type种类Kind说明Description
DefaultToolResultConverter类class
默认工具结果转换器,让智能体以受控方式调用外部能力。
Default implementation of ToolResultConverter.
NoOpToolEmitter类class
无 Op 工具 Emitter,让智能体以受控方式调用外部能力。
A no-op implementation of ToolEmitter that silently discards all emitted chunks.
SchemaOnlyTool类class
模式 Only 工具,封装可被智能体调用的能力。
An external tool implementation that only contains schema definition without execution logic.
SimpleExtendedModel类class
简单 Extended 模型,让智能体以受控方式调用外部能力。
Simple implementation of ExtendedModel using maps.
SkillToolGroup类class
技能工具组,让智能体以受控方式调用外部能力。
A `ToolGroup` that is bound to a specific skill.
ToolBase类class
工具基类,让智能体以受控方式调用外部能力。
Abstract base class for tools that participate in permission evaluation and ReAct execution.
ToolCallParam类class
工具调用参数,让智能体以受控方式调用外部能力。
Parameters for tool invocation.
ToolDangerousPathConstants类class
工具 Dangerous 路径 Constants,让智能体以受控方式调用外部能力。
Defaults for the dangerous-path and dangerous-command lists consulted by tool self-checks.
ToolExecutionContext类class
工具执行上下文,让智能体以受控方式调用外部能力。
Facade for passing custom POJOs to tool methods via priority-based resolution.
ToolGroup类class
工具组,让智能体以受控方式调用外部能力。
Represents a named group of tools with activation state.
Toolkit类class
工具注册表
Toolkit manages the registration, retrieval, and execution of agent tools.
ToolkitConfig类class
用于工具包执行行为的配置。
Configuration for Toolkit execution behavior.
ToolResultMessageBuilder类class
工具结果消息构建器,用于构建并配置目标实例。
Utility class for building tool result messages from ToolResultBlock objects.
ToolSchemaModule类class
工具模式 Module,让智能体以受控方式调用外部能力。
A victools JSON Schema `Module` that reads `ToolParam` annotations to populate `"description"` and `"required"` in the generated schema.
ToolSuspendException类class
工具 Suspend 异常,表示执行过程中的错误。
Exception thrown to signal that a tool execution should be suspended and handled externally.
ToolValidator类class
工具校验器,让智能体以受控方式调用外部能力。
Unified validator for tool-related operations.

枚举Enums

类型Type种类Kind说明Description
ToolGroupScope枚举enum
定义工具组范围相关取值的枚举。
Defines who manages a `ToolGroup`'s activation lifecycle.
ToolMergeMode枚举enum
定义工具 Merge 模式相关取值的枚举。
Enum defining how externally injected tools (e.g.

记录Records

类型Type种类Kind说明Description
ToolRequestConfig记录record
承载工具请求配置数据的记录类型。
Immutable per-call tool request config.

注解接口Annotation Interfaces

类型Type种类Kind说明Description
Tool注解annotation
用于标记工具相关元数据的注解。
Annotation to mark a method as a tool that can be invoked by AI agents.
ToolParam注解annotation
用于标记工具参数相关元数据的注解。
Annotation to describe parameters of a tool method.
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.