Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

6.4 KB
Raw Blame
import asyncio
from typing import TYPE_CHECKING, Any, Literal, Self, cast

from langchain_core.runnables import RunnableConfig
from pydantic import BaseModel, Field, create_model

from posthog.schema import AgentMode, AssistantTool

from posthog.models import Team, User

from ee.hogai.context import AssistantContextManager
from ee.hogai.tool import MaxTool
from ee.hogai.utils.prompt import format_prompt_string
from ee.hogai.utils.types.base import AssistantState, NodePath

if TYPE_CHECKING:
    from ee.hogai.core.agent_modes.factory import AgentModeDefinition

SWITCH_MODE_PROMPT = """
Use this tool to switch to a specialized mode with different tools and capabilities. Your conversation history and context are preserved across mode switches.

# Common tools (available in all modes)
{{{default_tools}}}

# Specialized modes
{{{available_modes}}}

Decision framework:
1. Check if you already have the necessary tools in your current mode
2. If not, identify which mode provides the tools you need
3. Switch to that mode using this tool

Switch when:
- You need a tool listed in another mode's toolkit (e.g., execute_sql is only in sql mode)
- The task type clearly maps to a specialized mode (SQL queries → sql mode, trend analysis → product_analytics mode)
- You've confirmed your current mode lacks required capabilities

Do NOT switch when:
- You can complete the task with your current tools
- The task is informational/explanatory (no tools needed)
- You're uncertain–check your current tools first

After switching, you'll have access to that mode's specialized tools while retaining access to all common tools.
""".strip()

SWITCH_MODE_TOOL_PROMPT = """
Successfully switched to {{{new_mode}}} mode. You now have access to this mode's specialized tools.
""".strip()


SWITCH_MODE_FAILURE_PROMPT = """
Failed to switch to {{{new_mode}}} mode. This mode does not exist. Available modes: {{{available_modes}}}.
""".strip()


async def _get_modes_prompt(
    *,
    team: Team,
    user: User,
    state: AssistantState | None = None,
    config: RunnableConfig | None = None,
    context_manager: AssistantContextManager,
    mode_registry: dict[AgentMode, "AgentModeDefinition"],
) -> str:
    """Get the prompt containing the description of the available modes."""

    all_futures: list[asyncio.Future[list[MaxTool]]] = []
    for definition in mode_registry.values():
        all_futures.append(
            asyncio.gather(
                *[
                    tool_class.create_tool_class(team=team, user=user, state=state, config=config)
                    for tool_class in definition.toolkit_class(
                        team=team, user=user, context_manager=context_manager
                    ).tools
                ]
            )
        )

    resolved_tools = await asyncio.gather(*all_futures)
    formatted_modes: list[str] = []
    for definition, tools in zip(mode_registry.values(), resolved_tools):
        formatted_modes.append(
            f"- {definition.mode.value} – {definition.mode_description}. [Mode tools: {', '.join([tool.get_name() for tool in tools])}]"
        )

    return "\n".join(formatted_modes)


async def _get_default_tools_prompt(
    *,
    team: Team,
    user: User,
    state: AssistantState | None = None,
    config: RunnableConfig | None = None,
    default_tool_classes: list[type["MaxTool"]],
) -> str:
    """Get the prompt containing the description of the default tools."""
    excluded_tool_classes: set[type[MaxTool]] = {SwitchModeTool}
    resolved_tools = await asyncio.gather(
        *[
            tool_class.create_tool_class(team=team, user=user, state=state, config=config)
            for tool_class in default_tool_classes
            if tool_class not in excluded_tool_classes
        ]
    )
    tools = [tool.get_name() for tool in resolved_tools]
    tools.append(AssistantTool.SWITCH_MODE)
    return ", ".join(tools)


class SwitchModeTool(MaxTool):
    name: Literal[AssistantTool.SWITCH_MODE] = AssistantTool.SWITCH_MODE
    _mode_registry: dict[AgentMode, "AgentModeDefinition"]

    async def _arun_impl(self, new_mode: str) -> tuple[str, AgentMode | None]:
        if new_mode not in self._mode_registry:
            available = ", ".join(self._mode_registry.keys())
            return (
                format_prompt_string(SWITCH_MODE_FAILURE_PROMPT, new_mode=new_mode, available_modes=available),
                self._state.agent_mode,
            )

        return format_prompt_string(SWITCH_MODE_TOOL_PROMPT, new_mode=new_mode), cast(AgentMode, new_mode)

    @classmethod
    async def create_tool_class(
        cls,
        *,
        team: Team,
        user: User,
        mode_registry: dict[AgentMode, "AgentModeDefinition"] | None = None,
        default_tool_classes: list[type["MaxTool"]] | None = None,
        node_path: tuple[NodePath, ...] | None = None,
        state: AssistantState | None = None,
        config: RunnableConfig | None = None,
        context_manager: AssistantContextManager | None = None,
    ) -> Self:
        if mode_registry is None or default_tool_classes is None:
            # These are set as optional parameters to make mypy happy
            raise ValueError("SwitchModeTool requires mode_registry and default_tool_classes parameters")

        context_manager = AssistantContextManager(team, user, config)
        default_tools, available_modes = await asyncio.gather(
            _get_default_tools_prompt(
                team=team, user=user, state=state, config=config, default_tool_classes=default_tool_classes
            ),
            _get_modes_prompt(
                team=team,
                user=user,
                state=state,
                config=config,
                context_manager=context_manager,
                mode_registry=mode_registry,
            ),
        )
        description_prompt = format_prompt_string(
            SWITCH_MODE_PROMPT, default_tools=default_tools, available_modes=available_modes
        )
        cls._mode_registry = mode_registry

        ModeKind = Literal[*mode_registry.keys()]  # type: ignore
        args_schema = create_model(
            "SwitchModeToolArgs",
            __base__=BaseModel,
            new_mode=(
                cast(Any, ModeKind),
                Field(description="The name of the mode to switch to."),
            ),
        )

        return cls(
            team=team,
            user=user,
            state=state,
            config=config,
            description=description_prompt,
            args_schema=args_schema,
        )