Commit 3f75409
authored
fix(toolsets): send a return description the way pydantic-ai sends one (#110)
`render` appended a prose `Returns: …` paragraph. pydantic-ai does
something else with a docstring's `Returns:` section — it wraps the
prose in `<summary>` and the return description in `<returns>`:
```
<summary>Draw a chart of numbers you already have, so the user can see them.
Use this whenever the user asks to plot, chart, graph or compare figures …</summary>
<returns>
<description>The chart specification, already on its way to the user.</description>
</returns>
```
So a host that registers these tools beside tools of its own ends up
with two conventions in one tool list: `create_chart`, built from a
docstring, arriving as XML, and `ls` arriving as prose describing the
same kind of thing. That shape was invented here, and inventing it was
the mistake — the framework already had one.
`render` emits the framework's shape now.
The test pins it against a tool pydantic-ai renders itself rather than
against a string literal:
```python
@native.tool_plain
def demo() -> str:
"""Do a thing.
A second paragraph of usage.
Returns:
One line per entry.
"""
assert ToolText(summary=..., usage=..., returns=...).render() == native.tools["demo"].tool_def.description
```
If pydantic-ai changes how it renders that section, this fails here
rather than leaving these tools quietly speaking the old dialect.
A `ToolText` with no `returns` is still plain prose, which is also what
the framework does with a docstring that has no `Returns:` section.
The `*_DESCRIPTION` constants carry the new shape with them. A catalogue
that wanted the prose reads `ToolText.summary` — the sentence it wanted
in the first place, and what agenticos already shows beside its approval
checkboxes.
Verified: 1716 tests pass, coverage 100%, pyright and mypy strict clean.1 parent 8a6d31e commit 3f75409
6 files changed
Lines changed: 104 additions & 4 deletions
File tree
- docs
- concepts
- src/pydantic_ai_backends/toolsets
- tests
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
10 | 25 | | |
11 | 26 | | |
12 | 27 | | |
| |||
Binary file not shown.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
91 | 91 | | |
92 | 92 | | |
93 | 93 | | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
94 | 112 | | |
95 | 113 | | |
96 | 114 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
11 | 16 | | |
12 | 17 | | |
13 | 18 | | |
| |||
69 | 74 | | |
70 | 75 | | |
71 | 76 | | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
72 | 87 | | |
73 | 88 | | |
74 | 89 | | |
| |||
77 | 92 | | |
78 | 93 | | |
79 | 94 | | |
80 | | - | |
81 | | - | |
82 | | - | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
83 | 102 | | |
84 | 103 | | |
85 | 104 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| 7 | + | |
7 | 8 | | |
8 | 9 | | |
9 | 10 | | |
| |||
70 | 71 | | |
71 | 72 | | |
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 | + | |
73 | 121 | | |
74 | 122 | | |
75 | 123 | | |
| |||
0 commit comments