Skip to content

ビルトインツール

Koogフレームワークは、エージェントとユーザーの一般的な対話シナリオを処理するビルトインツールを提供します。

以下のビルトインツールが利用可能です:

ツール
名前
説明
SayToUser__say_to_user__エージェントがユーザーにメッセージを送信できるようにします。Agent says: プレフィックス付きでエージェントのメッセージをコンソールに出力します。
AskUser__ask_user__エージェントがユーザーに入力を求められるようにします。エージェントのメッセージをコンソールに出力し、ユーザーの応答を待ちます。
ExitTool__exit__エージェントが会話を終了し、セッションを終了できるようにします。
ReadFileTool__read_file__テキストファイルを読み込みます(オプションで行範囲選択可能)。0から始まる行インデックスを使用して、フォーマットされた内容とメタデータを返します。
EditFileTool__edit_file__ファイル内で単一の特定テキスト置換を行い、新しいファイルを作成したり、内容を完全に置き換えたりすることもできます。
ListDirectoryTool__list_directory__ディレクトリの内容を、オプションの深さ制御とグロブフィルタリングを使用して、階層ツリーとして一覧表示します。
WriteFileTool__write_file__テキストコンテンツをファイルに書き込みます(必要に応じて親ディレクトリを作成します)。

ビルトインツールの登録

他のツールと同様に、ビルトインツールもエージェントが利用できるようにするためにツールレジストリに追加する必要があります。以下に例を示します:

kotlin
// Create a tool registry with all built-in tools
val toolRegistry = ToolRegistry {
    tool(SayToUser)
    tool(AskUser)
    tool(ExitTool)
    tool(ReadFileTool(JVMFileSystemProvider.ReadOnly))
    tool(ListDirectoryTool(JVMFileSystemProvider.ReadOnly))
    tool(WriteFileTool(JVMFileSystemProvider.ReadWrite))
}

// Pass the registry when creating an agent
val agent = AIAgent(
    promptExecutor = simpleOpenAIExecutor(apiToken),
    systemPrompt = "You are a helpful assistant.",
    llmModel = OpenAIModels.Chat.GPT4o,
    toolRegistry = toolRegistry
)

同じレジストリ内でビルトインツールとカスタムツールを組み合わせることで、エージェント向けの包括的な機能セットを作成できます。 カスタムツールの詳細については、アノテーションベースのツールおよびクラスベースのツールを参照してください。