ripperdoc 0.2.6__py3-none-any.whl

ripperdoc/tools/task_tool.py

@@ -0,0 +1,379 @@
+"""Task tool that delegates work to configured subagents."""
+
+from __future__ import annotations
+
+import time
+from typing import Any, AsyncGenerator, Callable, Dict, Iterable, List, Optional
+
+from pydantic import BaseModel, Field
+
+from ripperdoc.core.agents import (
+    AgentDefinition,
+    AgentLoadResult,
+    FILE_EDIT_TOOL_NAME,
+    GREP_TOOL_NAME,
+    VIEW_TOOL_NAME,
+    clear_agent_cache,
+    load_agent_definitions,
+    resolve_agent_tools,
+    summarize_agent,
+)
+from ripperdoc.core.query import QueryContext, query
+from ripperdoc.core.system_prompt import build_environment_prompt
+from ripperdoc.core.tool import Tool, ToolOutput, ToolProgress, ToolResult, ToolUseContext
+from ripperdoc.utils.messages import AssistantMessage, create_user_message
+from ripperdoc.utils.log import get_logger
+
+logger = get_logger()
+
+
+class TaskToolInput(BaseModel):
+    """Input schema for delegating to a subagent."""
+
+    prompt: str = Field(description="Detailed task description for the subagent to perform")
+    subagent_type: str = Field(description="Agent type to run (matches agent frontmatter name)")
+
+
+class TaskToolOutput(BaseModel):
+    """Summary of a completed subagent run."""
+
+    agent_type: str
+    result_text: str
+    duration_ms: float
+    tool_use_count: int
+    missing_tools: List[str] = Field(default_factory=list)
+    model_used: Optional[str] = None
+
+
+class TaskTool(Tool[TaskToolInput, TaskToolOutput]):
+    """Launches a configured agent in a fresh context."""
+
+    def __init__(self, available_tools_provider: Callable[[], Iterable[Tool[Any, Any]]]) -> None:
+        super().__init__()
+        self._available_tools_provider = available_tools_provider
+
+    @property
+    def name(self) -> str:
+        return "Task"
+
+    async def description(self) -> str:
+        clear_agent_cache()
+        agents = load_agent_definitions()
+        agent_lines = "\n".join(summarize_agent(agent) for agent in agents.active_agents)
+        return (
+            "Launch a specialized subagent in its own context window to handle a task.\n"
+            f"Available agents:\n{agent_lines or '- general-purpose (built-in)'}"
+        )
+
+    @property
+    def input_schema(self) -> type[TaskToolInput]:
+        return TaskToolInput
+
+    async def prompt(self, safe_mode: bool = False) -> str:
+        del safe_mode
+        clear_agent_cache()
+        agents: AgentLoadResult = load_agent_definitions()
+
+        agent_lines: List[str] = []
+        for agent in agents.active_agents:
+            properties = (
+                "Properties: access to current context; "
+                if getattr(agent, "fork_context", False)
+                else ""
+            )
+            tools_label = "All tools"
+            if getattr(agent, "tools", None):
+                tools_label = "All tools" if "*" in agent.tools else ", ".join(agent.tools)
+            agent_lines.append(
+                f"- {agent.agent_type}: {agent.when_to_use} ({properties}Tools: {tools_label})"
+            )
+
+        agent_block = "\n".join(agent_lines) or "- general-purpose (built-in)"
+
+        task_tool_name = self.name
+        file_read_tool_name = VIEW_TOOL_NAME
+        search_tool_name = GREP_TOOL_NAME
+        code_tool_name = FILE_EDIT_TOOL_NAME
+        background_fetch_tool_name = task_tool_name
+
+        return (
+            f"Launch a new agent to handle complex, multi-step tasks autonomously. \n\n"
+            f"The {task_tool_name} tool launches specialized agents (subprocesses) that autonomously handle complex tasks. Each agent type has specific capabilities and tools available to it.\n\n"
+            f"Available agent types and the tools they have access to:\n"
+            f"{agent_block}\n\n"
+            f"When using the {task_tool_name} tool, you must specify a subagent_type parameter to select which agent type to use.\n\n"
+            f"When NOT to use the {task_tool_name} tool:\n"
+            f"- If you want to read a specific file path, use the {file_read_tool_name} or {search_tool_name} tool instead of the {task_tool_name} tool, to find the match more quickly\n"
+            f'- If you are searching for a specific class definition like "class Foo", use the {search_tool_name} tool instead, to find the match more quickly\n'
+            f"- If you are searching for code within a specific file or set of 2-3 files, use the {file_read_tool_name} tool instead of the {task_tool_name} tool, to find the match more quickly\n"
+            "- Other tasks that are not related to the agent descriptions above\n"
+            "\n"
+            "\n"
+            "Usage notes:\n"
+            "- Launch multiple agents concurrently whenever possible, to maximize performance; to do that, use a single message with multiple tool uses\n"
+            "- When the agent is done, it will return a single message back to you. The result returned by the agent is not visible to the user. To show the user the result, you should send a text message back to the user with a concise summary of the result.\n"
+            f"- You can optionally run agents in the background using the run_in_background parameter. When an agent runs in the background, you will need to use {background_fetch_tool_name} to retrieve its results once it's done. You can continue to work while background agents run - When you need their results to continue you can use {background_fetch_tool_name} in blocking mode to pause and wait for their results.\n"
+            "- Agents can be resumed using the `resume` parameter by passing the agent ID from a previous invocation. When resumed, the agent continues with its full previous context preserved. When NOT resuming, each invocation starts fresh and you should provide a detailed task description with all necessary context.\n"
+            "- When the agent is done, it will return a single message back to you along with its agent ID. You can use this ID to resume the agent later if needed for follow-up work.\n"
+            "- Provide clear, detailed prompts so the agent can work autonomously and return exactly the information you need.\n"
+            '- Agents with "access to current context" can see the full conversation history before the tool call. When using these agents, you can write concise prompts that reference earlier context (e.g., "investigate the error discussed above") instead of repeating information. The agent will receive all prior messages and understand the context.\n'
+            "- The agent's outputs should generally be trusted\n"
+            "- Clearly tell the agent whether you expect it to write code or just to do research (search, file reads, web fetches, etc.), since it is not aware of the user's intent\n"
+            "- If the agent description mentions that it should be used proactively, then you should try your best to use it without the user having to ask for it first. Use your judgement.\n"
+            f'- If the user specifies that they want you to run agents "in parallel", you MUST send a single message with multiple {task_tool_name} tool use content blocks. For example, if you need to launch both a code-reviewer agent and a test-runner agent in parallel, send a single message with both tool calls.\n'
+            "\n"
+            "Example usage:\n"
+            "\n"
+            "<example_agent_descriptions>\n"
+            '"code-reviewer": use this agent after you are done writing a signficant piece of code\n'
+            '"greeting-responder": use this agent when to respond to user greetings with a friendly joke\n'
+            "</example_agent_description>\n"
+            "\n"
+            "<example>\n"
+            'user: "Please write a function that checks if a number is prime"\n'
+            "assistant: Sure let me write a function that checks if a number is prime\n"
+            f"assistant: First let me use the {code_tool_name} tool to write a function that checks if a number is prime\n"
+            f"assistant: I'm going to use the {code_tool_name} tool to write the following code:\n"
+            "<code>\n"
+            "function isPrime(n) {\n"
+            "  if (n <= 1) return false\n"
+            "  for (let i = 2; i * i <= n; i++) {\n"
+            "    if (n % i === 0) return false\n"
+            "  }\n"
+            "  return true\n"
+            "}\n"
+            "</code>\n"
+            "<commentary>\n"
+            "Since a signficant piece of code was written and the task was completed, now use the code-reviewer agent to review the code\n"
+            "</commentary>\n"
+            "assistant: Now let me use the code-reviewer agent to review the code\n"
+            f"assistant: Uses the {task_tool_name} tool to launch the code-reviewer agent \n"
+            "</example>\n"
+            "\n"
+            "<example>\n"
+            'user: "Hello"\n'
+            "<commentary>\n"
+            "Since the user is greeting, use the greeting-responder agent to respond with a friendly joke\n"
+            "</commentary>\n"
+            f'assistant: "I\'m going to use the {task_tool_name} tool to launch the greeting-responder agent"\n'
+            "</example>"
+        )
+
+    def is_read_only(self) -> bool:
+        return True
+
+    def is_concurrency_safe(self) -> bool:
+        return True
+
+    def render_result_for_assistant(self, output: TaskToolOutput) -> str:
+        details: List[str] = []
+        if output.tool_use_count:
+            details.append(f"{output.tool_use_count} tool uses")
+        details.append(f"{output.duration_ms / 1000:.1f}s")
+        if output.missing_tools:
+            details.append(f"missing tools: {', '.join(output.missing_tools)}")
+
+        suffix = f" ({'; '.join(details)})" if details else ""
+        return f"[subagent:{output.agent_type}] {output.result_text}{suffix}"
+
+    def render_tool_use_message(self, input_data: TaskToolInput, verbose: bool = False) -> str:
+        del verbose
+        return f"Task via {input_data.subagent_type}: {input_data.prompt}"
+
+    async def call(
+        self,
+        input_data: TaskToolInput,
+        context: ToolUseContext,
+    ) -> AsyncGenerator[ToolOutput, None]:
+        clear_agent_cache()
+        agents = load_agent_definitions()
+        target_agent = next(
+            (
+                agent
+                for agent in agents.active_agents
+                if agent.agent_type == input_data.subagent_type
+            ),
+            None,
+        )
+        if not target_agent:
+            raise ValueError(
+                f"Agent type '{input_data.subagent_type}' not found. "
+                f"Available agents: {', '.join(agent.agent_type for agent in agents.active_agents)}"
+            )
+
+        available_tools = list(self._available_tools_provider())
+        agent_tools, missing_tools = resolve_agent_tools(target_agent, available_tools, self.name)
+        if not agent_tools:
+            raise ValueError(
+                f"Agent '{target_agent.agent_type}' has no usable tools. "
+                f"Missing or unknown tools: {', '.join(missing_tools) if missing_tools else 'none'}"
+            )
+
+        # Type conversion: List[object] -> List[Tool[Any, Any]]
+        from ripperdoc.core.tool import Tool
+
+        typed_agent_tools: List[Tool[Any, Any]] = [
+            tool for tool in agent_tools if isinstance(tool, Tool)
+        ]
+
+        agent_system_prompt = self._build_agent_prompt(target_agent, typed_agent_tools)
+        subagent_messages = [create_user_message(input_data.prompt)]
+
+        subagent_context = QueryContext(
+            tools=typed_agent_tools,
+            safe_mode=context.safe_mode,
+            verbose=context.verbose,
+            model=target_agent.model or "task",
+        )
+
+        start = time.time()
+        assistant_messages: List[AssistantMessage] = []
+        tool_use_count = 0
+
+        yield ToolProgress(content=f"Launching subagent '{target_agent.agent_type}'")
+
+        async for message in query(
+            subagent_messages,  # type: ignore[arg-type]
+            agent_system_prompt,
+            {},
+            subagent_context,
+            context.permission_checker,
+        ):
+            if getattr(message, "type", "") == "assistant":
+                # Surface subagent tool requests as progress so the user sees activity.
+                msg_content = getattr(message, "message", None)
+                blocks = getattr(msg_content, "content", []) if msg_content else []
+                if isinstance(blocks, list):
+                    for block in blocks:
+                        block_type = getattr(block, "type", None) or (
+                            block.get("type") if isinstance(block, Dict) else None
+                        )
+                        if block_type == "tool_use":
+                            tool_name = getattr(block, "name", None) or (
+                                block.get("name") if isinstance(block, Dict) else "unknown tool"
+                            )
+                            block_input = (
+                                getattr(block, "input", None)
+                                if hasattr(block, "input")
+                                else (block.get("input") if isinstance(block, Dict) else None)
+                            )
+                            summary = self._summarize_tool_input(block_input)
+                            label = f"Subagent requesting {tool_name}"
+                            if summary:
+                                label += f" — {summary}"
+                            yield ToolProgress(content=label)
+                        if block_type == "text":
+                            text_val = getattr(block, "text", None) or (
+                                block.get("text") if isinstance(block, Dict) else ""
+                            )
+                            if text_val:
+                                snippet = str(text_val).strip()
+                                if snippet:
+                                    short = (
+                                        snippet if len(snippet) <= 200 else snippet[:197] + "..."
+                                    )
+                                    yield ToolProgress(content=f"Subagent: {short}")
+                assistant_messages.append(message)  # type: ignore[arg-type]
+                if isinstance(message, AssistantMessage):
+                    tool_use_count += self._count_tool_uses(message)
+
+        duration_ms = (time.time() - start) * 1000
+        result_text = (
+            self._extract_text(assistant_messages[-1])
+            if assistant_messages
+            else "Agent returned no response."
+        )
+
+        output = TaskToolOutput(
+            agent_type=target_agent.agent_type,
+            result_text=result_text.strip(),
+            duration_ms=duration_ms,
+            tool_use_count=tool_use_count,
+            missing_tools=missing_tools,
+            model_used=target_agent.model or "task",
+        )
+
+        yield ToolResult(data=output, result_for_assistant=self.render_result_for_assistant(output))
+
+    def _build_agent_prompt(self, agent: AgentDefinition, tools: List[Tool[Any, Any]]) -> str:
+        tool_names = ", ".join(tool.name for tool in tools if getattr(tool, "name", None))
+        guidance = (
+            "You are a specialized Ripperdoc subagent working autonomously. "
+            "Execute the task completely using the allowed tools. "
+            "Return a single, concise summary for the parent agent that includes what you did, "
+            "important findings, and any follow-ups. Do not ask the user questions."
+        )
+        sections = [
+            guidance,
+            f"Agent type: {agent.agent_type}",
+            f"When to use: {agent.when_to_use}",
+            f"Allowed tools: {tool_names}",
+            "Agent system prompt:",
+            agent.system_prompt or "(no additional prompt)",
+            build_environment_prompt(),
+        ]
+        return "\n\n".join(sections)
+
+    def _extract_text(self, message: AssistantMessage) -> str:
+        content = message.message.content
+        if isinstance(content, str):
+            return content
+        if isinstance(content, list):
+            parts: List[str] = []
+            for block in content:
+                text = getattr(block, "text", None) or (
+                    block.get("text") if isinstance(block, Dict) else None
+                )
+                if text:
+                    parts.append(str(text))
+            return "\n".join(parts)
+        return ""
+
+    def _count_tool_uses(self, message: AssistantMessage) -> int:
+        content = message.message.content
+        if not isinstance(content, list):
+            return 0
+        count = 0
+        for block in content:
+            block_type = getattr(block, "type", None) or (
+                block.get("type") if isinstance(block, Dict) else None
+            )
+            if block_type == "tool_use":
+                count += 1
+        return count
+
+    def _summarize_tool_input(self, inp: Any) -> str:
+        """Generate a short human-readable summary of a tool_use input."""
+        if not inp or not isinstance(inp, (dict, Dict)):
+            return ""
+
+        pieces: List[str] = []
+        # Prioritize common keys
+        for key in ("command", "file_path", "path", "glob", "pattern", "description", "prompt"):
+            if key in inp and inp[key]:
+                val = str(inp[key])
+                short = val if len(val) <= 80 else val[:77] + "..."
+                pieces.append(f"{key}={short}")
+
+        # Include range info if present
+        start = inp.get("start_line") or inp.get("offset")
+        end = inp.get("end_line") or inp.get("limit")
+        if start is not None or end is not None:
+            pieces.append(f"range={start or 0}-{end or '…'}")
+
+        if not pieces:
+            # Fallback to truncated dict representation
+            import json
+
+            try:
+                serialized = json.dumps(inp, ensure_ascii=False)
+            except (TypeError, ValueError) as exc:
+                logger.warning(
+                    "[task_tool] Failed to serialize tool_use input: %s: %s",
+                    type(exc).__name__, exc,
+                    extra={"tool_use_input": str(inp)[:200]},
+                )
+                serialized = str(inp)
+            return serialized if len(serialized) <= 120 else serialized[:117] + "..."
+
+        return ", ".join(pieces)