Skip to content

内置工具

Koog 框架提供内置工具,用于处理代理与用户交互的常见场景。

以下是可用的内置工具:

Tool
名称
Description
SayToUser__say_to_user__允许代理向用户发送消息。它会将代理消息打印到控制台,并带有 Agent says: 前缀。
AskUser__ask_user__允许代理向用户请求输入。它会将代理消息打印到控制台并等待用户响应。
ExitTool__exit__允许代理结束对话并终止会话。
ReadFileTool__read_file__读取文本文件,支持可选的行范围选择。返回带有元数据和基于 0 的行索引的格式化内容。
EditFileTool__edit_file__对文件进行单次、有针对性的文本替换;也可以创建新文件或完全替换其内容。
ListDirectoryTool__list_directory__列出目录内容,以分层树状结构显示,支持可选的深度控制和 glob 过滤。
WriteFileTool__write_file__将文本内容写入文件(如有需要,可创建父目录)。

注册内置工具

与任何其他工具一样,内置工具必须添加到工具注册表才能供代理使用。下面是一个示例:

kotlin
// 创建一个包含所有内置工具的工具注册表
val toolRegistry = ToolRegistry {
    tool(SayToUser)
    tool(AskUser)
    tool(ExitTool)
    tool(ReadFileTool(JVMFileSystemProvider.ReadOnly))
    tool(ListDirectoryTool(JVMFileSystemProvider.ReadOnly))
    tool(WriteFileTool(JVMFileSystemProvider.ReadWrite))
}

// 在创建代理时传入注册表
val agent = AIAgent(
    promptExecutor = simpleOpenAIExecutor(apiToken),
    systemPrompt = "You are a helpful assistant.",
    llmModel = OpenAIModels.Chat.GPT4o,
    toolRegistry = toolRegistry
)

通过在同一个注册表中结合内置工具和自定义工具,你可以为你的代理创建一套全面的能力。 要了解有关自定义工具的更多信息,请参见基于注解的工具基于类的工具