Function format_inline_tool_result

src/harness/tools/formatting.py:11–42

Format a tool result for display to the LLM. Handles special formatting for specific tools (like shell_run) and provides generic formatting for other tools. Args: function_name: Name of the tool that produced the result. payload: The tool's result payload. thoug

(
    function_name: str, payload: Any, thought_footer_message: Optional[str] = None
)

def format_inline_tool_result(
    function_name: str, payload: Any, thought_footer_message: Optional[str] = None
) -> str:
    """Format a tool result for display to the LLM.

    Handles special formatting for specific tools (like shell_run) and
    provides generic formatting for other tools.

    Args:
        function_name: Name of the tool that produced the result.
        payload: The tool's result payload.
        thought_footer_message: When set, appended as a footer to shell_run results.

    Returns:
        Formatted string representation of the result.

    Example:
        result = format_inline_tool_result("shell_run", {"returncode": 0, "output": "hello"})
        # Returns: "Return code: 0\\nOutput: hello"
    """
    # Unwrap nested result structures
    if (
        isinstance(payload, dict)
        and "result" in payload
        and isinstance(payload["result"], dict)
    ):
        payload = payload["result"]

    if function_name == "shell_run":
        return _format_shell_run(payload, thought_footer_message=thought_footer_message)

    return _format_generic_result(payload)


def _format_shell_run(