Skip to content

Tools

Bases: BoostedMagic

Source code in pydantic_ai_kernel/magics/tools_magic.py 
 15
 16
 17
 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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
class ToolsMagic(BoostedMagic):
    @boosted_option(
        "-v",
        "--verbose",
        action="store_true",
        default=False,
        help="Display verbose output",
    )
    @boosted_option(
        "-f",
        "--formatter",
        default=None,
        help="Formatter for the output. Must be supported by jupyter frontend. All formatter can be set by environment variable PYDANTIC_AI_KERNEL_FORMATTER",
        choices=out_formatter_list,
        completer=lambda w, r: complete_from_list(out_formatter_list, w, r),
    )
    def line_tools(self, verbose: bool = False, formatter: str | None = None):
        """
        %tools : tools of the agent

        Examples :
        -------
            • %tools -v : list tools, with verbose output
            • %tools --f=markdown : list of tools, mardown formatted
        """
        # Use kernel's configured formatter if not overridden
        env_formatter = getattr(self.kernel, "formatter", "text")
        if formatter is None:
            formatter = env_formatter
        self.kernel: PydanticAIBaseKernel  # type hints
        match formatter:
            case "text" | "terminal":
                self.text_format

                ter(verbose)
            case "md":
                if self.kernel.use_widget:
                    self.markdown_formatter_with_widget(verbose)
                else:
                    self.markdown_formatter(verbose)
            case _:
                raise NotImplementedError(
                    f"Unknown formatter : {formatter}. Accepted are : {out_formatter_list}"
                )

    def markdown_formatter_with_widget(self, verbose):
        """
        Display all tools in markdown
        """
        for each_tool in self.kernel.tools:
            if verbose:
                content = f"```python  \n{each_tool}```  \n"
            else:
                content = nice_tool_displaying(each_tool, formatter="md")

            self.kernel.Display(
                widgets.Accordion(
                    children=[
                        widgets.HTML(
                            value=content,
                            placeholder="",
                            description="",
                        )
                    ],
                    titles=[each_tool.name],
                )
            )
        if self.kernel.toolsets is not None:
            for each_toolset in self.kernel.toolsets:
                title = "toolset"
                if isinstance(each_toolset, ApprovalRequiredToolset):
                    each_toolset = each_toolset.wrapped
                content = ""
                if isinstance(each_toolset, FunctionToolset):
                    for each_tool in each_toolset.tools.values():
                        content += f"{each_tool.name}  \n"
                        if verbose:
                            content += f"{each_tool}  \n"
                        else:
                            content += nice_tool_displaying(each_tool, formatter="md")
                elif isinstance(each_toolset, FastMCPToolset):
                    content += f"- FastMCP : {each_toolset.client.transport.url}"
                else:
                    content += f"- {each_toolset}"
                widgets.Accordion(
                    children=[
                        widgets.HTML(
                            value=content,
                            placeholder="",
                            description="",
                        )
                    ],
                    titles=[title],
                )

    def markdown_formatter(self, verbose):
        """
        Display all tools in markdown
        """
        out = ""
        for each_tool in self.kernel.tools:
            out += f"### {each_tool.name}  \n"
            if verbose:
                out += f"```python  \n{each_tool}```  \n"
            else:
                out += nice_tool_displaying(each_tool, formatter="md")
        if self.kernel.toolsets is not None:
            for each_toolset in self.kernel.toolsets:
                out += "\n### toolset  \n"
                if isinstance(each_toolset, ApprovalRequiredToolset):
                    each_toolset = each_toolset.wrapped
                if isinstance(each_toolset, FunctionToolset):
                    for each_tool in each_toolset.tools.values():
                        out += f"#### {each_tool.name}  \n"
                        if verbose:
                            out += f"{each_tool}  \n"
                        else:
                            out += nice_tool_displaying(each_tool, formatter="md")
                elif isinstance(each_toolset, FastMCPToolset):
                    out += f"- FastMCP : {each_toolset.client.transport.url}"
                else:
                    out += f"- {each_toolset}"
        self.kernel.Display(
            {"text/markdown": out},
        )

    def text_formatter(self, verbose):
        """
        Display all tools, in raw text output, ready for terminal.
        """
        for each_tool in self.kernel.tools:
            self.kernel.Print(each_tool.name)
            if verbose:
                self.kernel.Print(each_tool)
            else:
                self.kernel.Print(
                    put_text_in_box(nice_tool_displaying(each_tool), indent=2)
                )

        if self.kernel.toolsets is not None:
            for each_toolset in self.kernel.toolsets:
                self.kernel.Print("Toolset :")
                out = ""
                if isinstance(each_toolset, ApprovalRequiredToolset):
                    each_toolset = each_toolset.wrapped
                if isinstance(each_toolset, FunctionToolset):
                    for each_tool in each_toolset.tools.values():
                        out += each_tool.name + "\n"
                        if verbose:
                            out += f"{each_tool}"
                        else:
                            out += nice_tool_displaying(each_tool)
                elif isinstance(each_toolset, FastMCPToolset):
                    out += f"   FastMCP : {each_toolset.client.transport.url}"
                else:
                    out += f"  {each_toolset}"
                self.kernel.Print(put_text_in_box(out, indent=2))

line_tools(verbose=False, formatter=None)

%tools : tools of the agent

Examples :

• %tools -v : list tools, with verbose output
• %tools --f=markdown : list of tools, mardown formatted
Source code in pydantic_ai_kernel/magics/tools_magic.py 
16
17
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
@boosted_option(
    "-v",
    "--verbose",
    action="store_true",
    default=False,
    help="Display verbose output",
)
@boosted_option(
    "-f",
    "--formatter",
    default=None,
    help="Formatter for the output. Must be supported by jupyter frontend. All formatter can be set by environment variable PYDANTIC_AI_KERNEL_FORMATTER",
    choices=out_formatter_list,
    completer=lambda w, r: complete_from_list(out_formatter_list, w, r),
)
def line_tools(self, verbose: bool = False, formatter: str | None = None):
    """
    %tools : tools of the agent

    Examples :
    -------
        • %tools -v : list tools, with verbose output
        • %tools --f=markdown : list of tools, mardown formatted
    """
    # Use kernel's configured formatter if not overridden
    env_formatter = getattr(self.kernel, "formatter", "text")
    if formatter is None:
        formatter = env_formatter
    self.kernel: PydanticAIBaseKernel  # type hints
    match formatter:
        case "text" | "terminal":
            self.text_format

            ter(verbose)
        case "md":
            if self.kernel.use_widget:
                self.markdown_formatter_with_widget(verbose)
            else:
                self.markdown_formatter(verbose)
        case _:
            raise NotImplementedError(
                f"Unknown formatter : {formatter}. Accepted are : {out_formatter_list}"
            )

markdown_formatter(verbose)

Display all tools in markdown

Source code in pydantic_ai_kernel/magics/tools_magic.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
def markdown_formatter(self, verbose):
    """
    Display all tools in markdown
    """
    out = ""
    for each_tool in self.kernel.tools:
        out += f"### {each_tool.name}  \n"
        if verbose:
            out += f"```python  \n{each_tool}```  \n"
        else:
            out += nice_tool_displaying(each_tool, formatter="md")
    if self.kernel.toolsets is not None:
        for each_toolset in self.kernel.toolsets:
            out += "\n### toolset  \n"
            if isinstance(each_toolset, ApprovalRequiredToolset):
                each_toolset = each_toolset.wrapped
            if isinstance(each_toolset, FunctionToolset):
                for each_tool in each_toolset.tools.values():
                    out += f"#### {each_tool.name}  \n"
                    if verbose:
                        out += f"{each_tool}  \n"
                    else:
                        out += nice_tool_displaying(each_tool, formatter="md")
            elif isinstance(each_toolset, FastMCPToolset):
                out += f"- FastMCP : {each_toolset.client.transport.url}"
            else:
                out += f"- {each_toolset}"
    self.kernel.Display(
        {"text/markdown": out},
    )

markdown_formatter_with_widget(verbose)

Display all tools in markdown

Source code in pydantic_ai_kernel/magics/tools_magic.py 
 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
108
def markdown_formatter_with_widget(self, verbose):
    """
    Display all tools in markdown
    """
    for each_tool in self.kernel.tools:
        if verbose:
            content = f"```python  \n{each_tool}```  \n"
        else:
            content = nice_tool_displaying(each_tool, formatter="md")

        self.kernel.Display(
            widgets.Accordion(
                children=[
                    widgets.HTML(
                        value=content,
                        placeholder="",
                        description="",
                    )
                ],
                titles=[each_tool.name],
            )
        )
    if self.kernel.toolsets is not None:
        for each_toolset in self.kernel.toolsets:
            title = "toolset"
            if isinstance(each_toolset, ApprovalRequiredToolset):
                each_toolset = each_toolset.wrapped
            content = ""
            if isinstance(each_toolset, FunctionToolset):
                for each_tool in each_toolset.tools.values():
                    content += f"{each_tool.name}  \n"
                    if verbose:
                        content += f"{each_tool}  \n"
                    else:
                        content += nice_tool_displaying(each_tool, formatter="md")
            elif isinstance(each_toolset, FastMCPToolset):
                content += f"- FastMCP : {each_toolset.client.transport.url}"
            else:
                content += f"- {each_toolset}"
            widgets.Accordion(
                children=[
                    widgets.HTML(
                        value=content,
                        placeholder="",
                        description="",
                    )
                ],
                titles=[title],
            )

text_formatter(verbose)

Display all tools, in raw text output, ready for terminal.

Source code in pydantic_ai_kernel/magics/tools_magic.py 
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
def text_formatter(self, verbose):
    """
    Display all tools, in raw text output, ready for terminal.
    """
    for each_tool in self.kernel.tools:
        self.kernel.Print(each_tool.name)
        if verbose:
            self.kernel.Print(each_tool)
        else:
            self.kernel.Print(
                put_text_in_box(nice_tool_displaying(each_tool), indent=2)
            )

    if self.kernel.toolsets is not None:
        for each_toolset in self.kernel.toolsets:
            self.kernel.Print("Toolset :")
            out = ""
            if isinstance(each_toolset, ApprovalRequiredToolset):
                each_toolset = each_toolset.wrapped
            if isinstance(each_toolset, FunctionToolset):
                for each_tool in each_toolset.tools.values():
                    out += each_tool.name + "\n"
                    if verbose:
                        out += f"{each_tool}"
                    else:
                        out += nice_tool_displaying(each_tool)
            elif isinstance(each_toolset, FastMCPToolset):
                out += f"   FastMCP : {each_toolset.client.transport.url}"
            else:
                out += f"  {each_toolset}"
            self.kernel.Print(put_text_in_box(out, indent=2))