Skip to content

anthropic.tools

Classes for using tools with Anthropic's Claude API.

AnthropicTool

Bases: BaseTool[ToolUseBlock]

A base class for easy use of tools with the Anthropic Claude client.

AnthropicTool internally handles the logic that allows you to use tools with simple calls such as AnthropicCallResponse.tool or AnthropicTool.fn, as seen in the example below.

Example:

from mirascope import AnthropicCall, AnthropicCallParams


def animal_matcher(fav_food: str, fav_color: str) -> str:
    """Tells you your most likely favorite animal from personality traits.

    Args:
        fav_food: your favorite food.
        fav_color: your favorite color.

    Returns:
        The animal most likely to be your favorite based on traits.
    """
    return "Your favorite animal is the best one, a frog."


class AnimalMatcher(AnthropicCall):
    prompt_template = """
    Tell me my favorite animal if my favorite food is {food} and my
    favorite color is {color}.
    """

    food: str
    color: str

    call_params = AnthropicCallParams(tools=[animal_matcher])


response = AnimalMatcher(food="pizza", color="red").call
tool = response.tool
print(tool.fn(**tool.args))
#> Your favorite animal is the best one, a frog.
Source code in mirascope/anthropic/tools.py 
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
class AnthropicTool(BaseTool[ToolUseBlock]):
    '''A base class for easy use of tools with the Anthropic Claude client.

    `AnthropicTool` internally handles the logic that allows you to use tools with
    simple calls such as `AnthropicCallResponse.tool` or `AnthropicTool.fn`, as seen in
    the example below.

    Example:

    ```python
    from mirascope import AnthropicCall, AnthropicCallParams


    def animal_matcher(fav_food: str, fav_color: str) -> str:
        """Tells you your most likely favorite animal from personality traits.

        Args:
            fav_food: your favorite food.
            fav_color: your favorite color.

        Returns:
            The animal most likely to be your favorite based on traits.
        """
        return "Your favorite animal is the best one, a frog."


    class AnimalMatcher(AnthropicCall):
        prompt_template = """
        Tell me my favorite animal if my favorite food is {food} and my
        favorite color is {color}.
        """

        food: str
        color: str

        call_params = AnthropicCallParams(tools=[animal_matcher])


    response = AnimalMatcher(food="pizza", color="red").call
    tool = response.tool
    print(tool.fn(**tool.args))
    #> Your favorite animal is the best one, a frog.
    ```
    '''

    @classmethod
    def tool_schema(cls) -> ToolParam:
        """Constructs JSON tool schema for use with Anthropic's Claude API."""
        schema = super().tool_schema()
        return ToolParam(
            input_schema=schema["parameters"],
            name=schema["name"],
            description=schema["description"],
        )

    @classmethod
    def from_tool_call(cls, tool_call: ToolUseBlock) -> AnthropicTool:
        """Extracts an instance of the tool constructed from a tool call response.

        Given the tool call contents in a `Message` from an Anthropic call response,
        this method parses out the arguments of the tool call and creates an
        `AnthropicTool` instance from them.

        Args:
            tool_call: The list of `TextBlock` contents.

        Returns:
            An instance of the tool constructed from the tool call.

        Raises:
            ValidationError: if the tool call doesn't match the tool schema.
        """
        model_json = tool_call.input
        model_json["tool_call"] = tool_call.model_dump()  # type: ignore
        return cls.model_validate(model_json)

    @classmethod
    def from_model(cls, model: Type[BaseModel]) -> Type[AnthropicTool]:
        """Constructs a `AnthropicTool` type from a `BaseModel` type."""
        return convert_base_model_to_tool(model, AnthropicTool)

    @classmethod
    def from_fn(cls, fn: Callable) -> Type[AnthropicTool]:
        """Constructs a `AnthropicTool` type from a function."""
        return convert_function_to_tool(fn, AnthropicTool)

    @classmethod
    def from_base_type(cls, base_type: Type[BaseType]) -> Type[AnthropicTool]:
        """Constructs a `AnthropicTool` type from a `BaseType` type."""
        return convert_base_type_to_tool(base_type, AnthropicTool)

from_base_type(base_type) classmethod

Constructs a AnthropicTool type from a BaseType type.

Source code in mirascope/anthropic/tools.py 
104
105
106
107
@classmethod
def from_base_type(cls, base_type: Type[BaseType]) -> Type[AnthropicTool]:
    """Constructs a `AnthropicTool` type from a `BaseType` type."""
    return convert_base_type_to_tool(base_type, AnthropicTool)

from_fn(fn) classmethod

Constructs a AnthropicTool type from a function.

Source code in mirascope/anthropic/tools.py 
 99
100
101
102
@classmethod
def from_fn(cls, fn: Callable) -> Type[AnthropicTool]:
    """Constructs a `AnthropicTool` type from a function."""
    return convert_function_to_tool(fn, AnthropicTool)

from_model(model) classmethod

Constructs a AnthropicTool type from a BaseModel type.

Source code in mirascope/anthropic/tools.py 
94
95
96
97
@classmethod
def from_model(cls, model: Type[BaseModel]) -> Type[AnthropicTool]:
    """Constructs a `AnthropicTool` type from a `BaseModel` type."""
    return convert_base_model_to_tool(model, AnthropicTool)

from_tool_call(tool_call) classmethod

Extracts an instance of the tool constructed from a tool call response.

Given the tool call contents in a Message from an Anthropic call response, this method parses out the arguments of the tool call and creates an AnthropicTool instance from them.

Parameters:

Name Type Description Default
tool_call ToolUseBlock

The list of TextBlock contents.

 required

Returns:

Type Description
AnthropicTool

An instance of the tool constructed from the tool call.

Raises:

Type Description
ValidationError

if the tool call doesn't match the tool schema.
Source code in mirascope/anthropic/tools.py 
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
@classmethod
def from_tool_call(cls, tool_call: ToolUseBlock) -> AnthropicTool:
    """Extracts an instance of the tool constructed from a tool call response.

    Given the tool call contents in a `Message` from an Anthropic call response,
    this method parses out the arguments of the tool call and creates an
    `AnthropicTool` instance from them.

    Args:
        tool_call: The list of `TextBlock` contents.

    Returns:
        An instance of the tool constructed from the tool call.

    Raises:
        ValidationError: if the tool call doesn't match the tool schema.
    """
    model_json = tool_call.input
    model_json["tool_call"] = tool_call.model_dump()  # type: ignore
    return cls.model_validate(model_json)

tool_schema() classmethod

Constructs JSON tool schema for use with Anthropic's Claude API.

Source code in mirascope/anthropic/tools.py 
63
64
65
66
67
68
69
70
71
@classmethod
def tool_schema(cls) -> ToolParam:
    """Constructs JSON tool schema for use with Anthropic's Claude API."""
    schema = super().tool_schema()
    return ToolParam(
        input_schema=schema["parameters"],
        name=schema["name"],
        description=schema["description"],
    )