Function build_tool

src/tool_system/build_tool.py:121–209

(
    *,
    name: str,
    input_schema: Mapping[str, Any],
    call: Callable[[dict[str, Any], ToolContext], ToolResult],
    prompt: Callable[..., str] | str | None = None,
    description: Callable[[dict[str, Any]], str] | str | None = None,
    map_result_to_api: Callable[[Any, str], dict[str, Any]] | None = None,
    aliases: tuple[str, ...] | list[str] = (),
    search_hint: str | None = None,
    max_result_size_chars: int | float = 20_000,
    strict: bool = False,
    should_defer: bool = False,
    always_load: bool = False,
    is_mcp: bool = False,
    is_lsp: bool = False,
    is_enabled: Callable[[], bool] | None = None,
    is_concurrency_safe: Callable[[dict[str, Any]], bool] | None = None,
    is_read_only: Callable[[dict[str, Any]], bool] | None = None,
    is_destructive: Callable[[dict[str, Any]], bool] | None = None,
    check_permissions: Callable[[dict[str, Any], ToolContext], PermissionResult] | None = None,
    validate_input: Callable[[dict[str, Any], ToolContext], ValidationResult] | None = None,
    user_facing_name: Callable[[dict[str, Any] | None], str] | None = None,
    get_path: Callable[[dict[str, Any]], str] | None = None,
    to_auto_classifier_input: Callable[[dict[str, Any]], Any] | None = None,
    input_json_schema: Mapping[str, Any] | None = None,
    mcp_info: McpInfo | None = None,
    interrupt_behavior: Callable[[], Literal["cancel", "block"]] | None = None,
    is_search_or_read_command: Callable[[dict[str, Any]], SearchOrReadResult] | None = None,
    is_open_world: Callable[[dict[str, Any]], bool] | None = None,
    requires_user_interaction: Callable[[], bool] | None = None,
    inputs_equivalent: Callable[[dict[str, Any], dict[str, Any]], bool] | None = None,
    backfill_observable_input: Callable[[dict[str, Any]], None] | None = None,
    prepare_permission_matcher: Callable[[dict[str, Any]], Callable[[str], bool]] | None = None,
    get_tool_use_summary: Callable[[dict[str, Any] | None], str | None] | None = None,
    get_activity_description: Callable[[dict[str, Any] | None], str | None] | None = None,
)

def build_tool(
    *,
    name: str,
    input_schema: Mapping[str, Any],
    call: Callable[[dict[str, Any], ToolContext], ToolResult],
    prompt: Callable[..., str] | str | None = None,
    description: Callable[[dict[str, Any]], str] | str | None = None,
    map_result_to_api: Callable[[Any, str], dict[str, Any]] | None = None,
    aliases: tuple[str, ...] | list[str] = (),
    search_hint: str | None = None,
    max_result_size_chars: int | float = 20_000,
    strict: bool = False,
    should_defer: bool = False,
    always_load: bool = False,
    is_mcp: bool = False,
    is_lsp: bool = False,
    is_enabled: Callable[[], bool] | None = None,
    is_concurrency_safe: Callable[[dict[str, Any]], bool] | None = None,
    is_read_only: Callable[[dict[str, Any]], bool] | None = None,
    is_destructive: Callable[[dict[str, Any]], bool] | None = None,
    check_permissions: Callable[[dict[str, Any], ToolContext], PermissionResult] | None = None,
    validate_input: Callable[[dict[str, Any], ToolContext], ValidationResult] | None = None,
    user_facing_name: Callable[[dict[str, Any] | None], str] | None = None,
    get_path: Callable[[dict[str, Any]], str] | None = None,
    to_auto_classifier_input: Callable[[dict[str, Any]], Any] | None = None,
    input_json_schema: Mapping[str, Any] | None = None,
    mcp_info: McpInfo | None = None,
    interrupt_behavior: Callable[[], Literal["cancel", "block"]] | None = None,
    is_search_or_read_command: Callable[[dict[str, Any]], SearchOrReadResult] | None = None,
    is_open_world: Callable[[dict[str, Any]], bool] | None = None,
    requires_user_interaction: Callable[[], bool] | None = None,
    inputs_equivalent: Callable[[dict[str, Any], dict[str, Any]], bool] | None = None,
    backfill_observable_input: Callable[[dict[str, Any]], None] | None = None,
    prepare_permission_matcher: Callable[[dict[str, Any]], Callable[[str], bool]] | None = None,
    get_tool_use_summary: Callable[[dict[str, Any] | None], str | None] | None = None,
    get_activity_description: Callable[[dict[str, Any] | None], str | None] | None = None,
) -> Tool:
    if isinstance(prompt, str):
        _p = prompt
        prompt_fn: Callable[..., str] = lambda: _p
    elif prompt is None:
        prompt_fn = lambda: ""
    else:
        prompt_fn = prompt

    if isinstance(description, str):
        _d = description
        desc_fn: Callable[[dict[str, Any]], str] = lambda _input: _d
    elif description is None:
        desc_fn = lambda _input: name
    else:
        desc_fn = description

    return Tool(
        name=name,
        input_schema=input_schema,
        call=call,
        prompt=prompt_fn,