Skip to content

fix: yield tool responses before confirmations #765

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gustafvh wants to merge 1 commit into
base: main
Choose a base branch
from
+100 −43
Open

fix: yield tool responses before confirmations #765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions internal/llminternal/base_flow.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,16 +204,19 @@ func (f *Flow) runOneStep(ctx agent.InvocationContext) iter.Seq2[*session.Event,
}

toolConfirmationEvent := generateRequestConfirmationEvent(ctx, modelResponseEvent, ev)

// Yield function responses before confirmation requests so consumers that
// pause for user approval still persist completed tool results.
if !yield(ev, nil) {
return
}

if toolConfirmationEvent != nil {
if !yield(toolConfirmationEvent, nil) {
return
}
}

if !yield(ev, nil) {
return
}

// If the model response is structured, yield it as a final model response event.
outputSchemaResponse, err := retrieveStructuredModelResponse(ev)
if err != nil {
Expand Down
90 changes: 72 additions & 18 deletions tool/functiontool/function_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -584,6 +584,9 @@ func TestToolConfirmation(t *testing.T) {
args: map[string]any{"Num": 1},
want: []*genai.Content{
genai.NewContentFromFunctionCall("test_tool", map[string]any{"Num": 1}, "model"),
genai.NewContentFromFunctionResponse("test_tool", map[string]any{
"error": errors.New("error tool \"test_tool\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionCall(toolconfirmation.FunctionCallName, map[string]any{
"originalFunctionCall": &genai.FunctionCall{
Args: map[string]any{"Num": 1},
Expand All @@ -593,9 +596,6 @@ func TestToolConfirmation(t *testing.T) {
Hint: "Please approve or reject the tool call test_tool() by responding with a FunctionResponse with an expected ToolConfirmation payload.",
},
}, "model"),
genai.NewContentFromFunctionResponse("test_tool", map[string]any{
"error": errors.New("error tool \"test_tool\" requires confirmation, please approve or reject"),
}, "user"),
},
},
{
Expand All @@ -608,6 +608,9 @@ func TestToolConfirmation(t *testing.T) {
confirmFunctionResponse: &genai.FunctionResponse{Name: toolconfirmation.FunctionCallName, Response: map[string]any{"confirmed": true}},
want: []*genai.Content{
genai.NewContentFromFunctionCall("test_tool", map[string]any{"Num": 1}, "model"),
genai.NewContentFromFunctionResponse("test_tool", map[string]any{
"error": errors.New("error tool \"test_tool\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionCall(toolconfirmation.FunctionCallName, map[string]any{
"originalFunctionCall": &genai.FunctionCall{
Args: map[string]any{"Num": 1},
Expand All @@ -617,9 +620,6 @@ func TestToolConfirmation(t *testing.T) {
Hint: "Please approve or reject the tool call test_tool() by responding with a FunctionResponse with an expected ToolConfirmation payload.",
},
}, "model"),
genai.NewContentFromFunctionResponse("test_tool", map[string]any{
"error": errors.New("error tool \"test_tool\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionResponse("test_tool", map[string]any{"result": "ok"}, "user"),
},
},
Expand All @@ -633,6 +633,9 @@ func TestToolConfirmation(t *testing.T) {
confirmFunctionResponse: &genai.FunctionResponse{Name: toolconfirmation.FunctionCallName, Response: map[string]any{"confirmed": false}},
want: []*genai.Content{
genai.NewContentFromFunctionCall("test_tool", map[string]any{"Num": 1}, "model"),
genai.NewContentFromFunctionResponse("test_tool", map[string]any{
"error": errors.New("error tool \"test_tool\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionCall(toolconfirmation.FunctionCallName, map[string]any{
"originalFunctionCall": &genai.FunctionCall{
Args: map[string]any{"Num": 1},
Expand All @@ -642,9 +645,6 @@ func TestToolConfirmation(t *testing.T) {
Hint: "Please approve or reject the tool call test_tool() by responding with a FunctionResponse with an expected ToolConfirmation payload.",
},
}, "model"),
genai.NewContentFromFunctionResponse("test_tool", map[string]any{
"error": errors.New("error tool \"test_tool\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionResponse("test_tool", map[string]any{
"error": errors.New("error tool \"test_tool\" call is rejected"),
}, "user"),
Expand Down Expand Up @@ -675,6 +675,9 @@ func TestToolConfirmation(t *testing.T) {
args: map[string]any{"Num": 4},
want: []*genai.Content{
genai.NewContentFromFunctionCall("test_tool", map[string]any{"Num": 4}, "model"),
genai.NewContentFromFunctionResponse("test_tool", map[string]any{
"error": errors.New("error tool \"test_tool\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionCall(toolconfirmation.FunctionCallName, map[string]any{
"originalFunctionCall": &genai.FunctionCall{
Args: map[string]any{"Num": 4},
Expand All @@ -684,9 +687,6 @@ func TestToolConfirmation(t *testing.T) {
Hint: "Please approve or reject the tool call test_tool() by responding with a FunctionResponse with an expected ToolConfirmation payload.",
},
}, "model"),
genai.NewContentFromFunctionResponse("test_tool", map[string]any{
"error": errors.New("error tool \"test_tool\" requires confirmation, please approve or reject"),
}, "user"),
},
},
{
Expand All @@ -701,6 +701,9 @@ func TestToolConfirmation(t *testing.T) {
confirmFunctionResponse: &genai.FunctionResponse{Name: toolconfirmation.FunctionCallName, Response: map[string]any{"confirmed": true}},
want: []*genai.Content{
genai.NewContentFromFunctionCall("test_tool", map[string]any{"Num": 4}, "model"),
genai.NewContentFromFunctionResponse("test_tool", map[string]any{
"error": errors.New("error tool \"test_tool\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionCall(toolconfirmation.FunctionCallName, map[string]any{
"originalFunctionCall": &genai.FunctionCall{
Args: map[string]any{"Num": 4},
Expand All @@ -710,9 +713,6 @@ func TestToolConfirmation(t *testing.T) {
Hint: "Please approve or reject the tool call test_tool() by responding with a FunctionResponse with an expected ToolConfirmation payload.",
},
}, "model"),
genai.NewContentFromFunctionResponse("test_tool", map[string]any{
"error": errors.New("error tool \"test_tool\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionResponse("test_tool", map[string]any{"result": "ok"}, "user"),
},
},
Expand All @@ -728,6 +728,9 @@ func TestToolConfirmation(t *testing.T) {
confirmFunctionResponse: &genai.FunctionResponse{Name: toolconfirmation.FunctionCallName, Response: map[string]any{"confirmed": false}},
want: []*genai.Content{
genai.NewContentFromFunctionCall("test_tool", map[string]any{"Num": 4}, "model"),
genai.NewContentFromFunctionResponse("test_tool", map[string]any{
"error": errors.New("error tool \"test_tool\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionCall(toolconfirmation.FunctionCallName, map[string]any{
"originalFunctionCall": &genai.FunctionCall{
Args: map[string]any{"Num": 4},
Expand All @@ -737,9 +740,6 @@ func TestToolConfirmation(t *testing.T) {
Hint: "Please approve or reject the tool call test_tool() by responding with a FunctionResponse with an expected ToolConfirmation payload.",
},
}, "model"),
genai.NewContentFromFunctionResponse("test_tool", map[string]any{
"error": errors.New("error tool \"test_tool\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionResponse("test_tool", map[string]any{
"error": errors.New("error tool \"test_tool\" call is rejected"),
}, "user"),
Expand Down Expand Up @@ -865,6 +865,60 @@ func TestToolConfirmation(t *testing.T) {
}
}

func TestToolConfirmationYieldsFunctionResponseBeforeConfirmation(t *testing.T) {
mockModel := &testutil.MockModel{
Responses: []*genai.Content{
genai.NewContentFromFunctionCall("test_tool", map[string]any{"Num": 1}, genai.RoleModel),
},
}

myTool, err := functiontool.New(functiontool.Config{
Name: "test_tool",
RequireConfirmation: true,
}, okFunc)
if err != nil {
t.Fatalf("Failed to create tool: %v", err)
}

a, err := llmagent.New(llmagent.Config{
Name: "simple agent",
Model: mockModel,
Tools: []tool.Tool{myTool},
})
if err != nil {
t.Fatalf("failed to create llm agent: %v", err)
}

runner := testutil.NewTestAgentRunner(t, a)
sawFunctionResponse := false
sawConfirmation := false

for got, err := range runner.Run(t, "id", "message") {
// The mock model emits a sentinel error once exhausted; treat any
// error as end-of-stream and rely on the post-loop assertions.
if err != nil {
break
}

for _, part := range got.Content.Parts {
if part.FunctionResponse != nil && part.FunctionResponse.Name == "test_tool" {
sawFunctionResponse = true
}
if part.FunctionCall != nil && part.FunctionCall.Name == toolconfirmation.FunctionCallName {
sawConfirmation = true
if !sawFunctionResponse {
t.Fatal("confirmation was yielded before the tool function response")
}
return
}
}
}

if !sawConfirmation {
t.Fatal("expected confirmation event")
}
}

// Mock types for TArgs and TResults
type TestArgs struct {
Name string
Expand Down
42 changes: 21 additions & 21 deletions tool/mcptoolset/set_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,9 @@ func TestMCPToolSetConfirmation(t *testing.T) {
city: "Lisbon",
want: []*genai.Content{
genai.NewContentFromFunctionCall(toolName, map[string]any{"city": "Lisbon"}, "model"),
genai.NewContentFromFunctionResponse(toolName, map[string]any{
"error": errors.New("error tool \"get_weather\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionCall(toolconfirmation.FunctionCallName, map[string]any{
"originalFunctionCall": &genai.FunctionCall{
Args: map[string]any{"city": "Lisbon"},
Expand All @@ -424,9 +427,6 @@ func TestMCPToolSetConfirmation(t *testing.T) {
Hint: "Please approve or reject the tool call get_weather() by responding with a FunctionResponse with an expected ToolConfirmation payload.",
},
}, "model"),
genai.NewContentFromFunctionResponse(toolName, map[string]any{
"error": errors.New("error tool \"get_weather\" requires confirmation, please approve or reject"),
}, "user"),
},
},
{
Expand All @@ -438,6 +438,9 @@ func TestMCPToolSetConfirmation(t *testing.T) {
confirmFunctionResponse: &genai.FunctionResponse{Name: toolconfirmation.FunctionCallName, Response: map[string]any{"confirmed": true}},
want: []*genai.Content{
genai.NewContentFromFunctionCall(toolName, map[string]any{"city": "Lisbon"}, "model"),
genai.NewContentFromFunctionResponse(toolName, map[string]any{
"error": errors.New("error tool \"get_weather\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionCall(toolconfirmation.FunctionCallName, map[string]any{
"originalFunctionCall": &genai.FunctionCall{
Args: map[string]any{"city": "Lisbon"},
Expand All @@ -447,9 +450,6 @@ func TestMCPToolSetConfirmation(t *testing.T) {
Hint: "Please approve or reject the tool call get_weather() by responding with a FunctionResponse with an expected ToolConfirmation payload.",
},
}, "model"),
genai.NewContentFromFunctionResponse(toolName, map[string]any{
"error": errors.New("error tool \"get_weather\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionResponse(toolName, map[string]any{
"output": map[string]any{"weather_summary": string(`Today in "Lisbon" is sunny`)},
}, "user"),
Expand All @@ -465,6 +465,9 @@ func TestMCPToolSetConfirmation(t *testing.T) {
confirmFunctionResponse: &genai.FunctionResponse{Name: toolconfirmation.FunctionCallName, Response: map[string]any{"confirmed": false}},
want: []*genai.Content{
genai.NewContentFromFunctionCall(toolName, map[string]any{"city": "Lisbon"}, "model"),
genai.NewContentFromFunctionResponse(toolName, map[string]any{
"error": errors.New("error tool \"get_weather\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionCall(toolconfirmation.FunctionCallName, map[string]any{
"originalFunctionCall": &genai.FunctionCall{
Args: map[string]any{"city": "Lisbon"},
Expand All @@ -474,9 +477,6 @@ func TestMCPToolSetConfirmation(t *testing.T) {
Hint: "Please approve or reject the tool call get_weather() by responding with a FunctionResponse with an expected ToolConfirmation payload.",
},
}, "model"),
genai.NewContentFromFunctionResponse(toolName, map[string]any{
"error": errors.New("error tool \"get_weather\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionResponse(toolName, map[string]any{
"error": errors.New("error tool \"get_weather\" call is rejected"),
}, "user"),
Expand Down Expand Up @@ -523,6 +523,9 @@ func TestMCPToolSetConfirmation(t *testing.T) {
city: "Lisbon",
want: []*genai.Content{
genai.NewContentFromFunctionCall(toolName, map[string]any{"city": "Lisbon"}, "model"),
genai.NewContentFromFunctionResponse(toolName, map[string]any{
"error": errors.New("error tool \"get_weather\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionCall(toolconfirmation.FunctionCallName, map[string]any{
"originalFunctionCall": &genai.FunctionCall{
Args: map[string]any{"city": "Lisbon"},
Expand All @@ -532,9 +535,6 @@ func TestMCPToolSetConfirmation(t *testing.T) {
Hint: "Please approve or reject the tool call get_weather() by responding with a FunctionResponse with an expected ToolConfirmation payload.",
},
}, "model"),
genai.NewContentFromFunctionResponse(toolName, map[string]any{
"error": errors.New("error tool \"get_weather\" requires confirmation, please approve or reject"),
}, "user"),
},
},
{
Expand All @@ -545,6 +545,9 @@ func TestMCPToolSetConfirmation(t *testing.T) {
city: "Lisbon",
want: []*genai.Content{
genai.NewContentFromFunctionCall(toolName, map[string]any{"city": "Lisbon"}, "model"),
genai.NewContentFromFunctionResponse(toolName, map[string]any{
"error": errors.New("error tool \"get_weather\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionCall(toolconfirmation.FunctionCallName, map[string]any{
"originalFunctionCall": &genai.FunctionCall{
Args: map[string]any{"city": "Lisbon"},
Expand All @@ -554,9 +557,6 @@ func TestMCPToolSetConfirmation(t *testing.T) {
Hint: "Please approve or reject the tool call get_weather() by responding with a FunctionResponse with an expected ToolConfirmation payload.",
},
}, "model"),
genai.NewContentFromFunctionResponse(toolName, map[string]any{
"error": errors.New("error tool \"get_weather\" requires confirmation, please approve or reject"),
}, "user"),
},
},
{
Expand All @@ -568,6 +568,9 @@ func TestMCPToolSetConfirmation(t *testing.T) {
confirmFunctionResponse: &genai.FunctionResponse{Name: toolconfirmation.FunctionCallName, Response: map[string]any{"confirmed": true}},
want: []*genai.Content{
genai.NewContentFromFunctionCall(toolName, map[string]any{"city": "Lisbon"}, "model"),
genai.NewContentFromFunctionResponse(toolName, map[string]any{
"error": errors.New("error tool \"get_weather\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionCall(toolconfirmation.FunctionCallName, map[string]any{
"originalFunctionCall": &genai.FunctionCall{
Args: map[string]any{"city": "Lisbon"},
Expand All @@ -577,9 +580,6 @@ func TestMCPToolSetConfirmation(t *testing.T) {
Hint: "Please approve or reject the tool call get_weather() by responding with a FunctionResponse with an expected ToolConfirmation payload.",
},
}, "model"),
genai.NewContentFromFunctionResponse(toolName, map[string]any{
"error": errors.New("error tool \"get_weather\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionResponse(toolName, map[string]any{
"output": map[string]any{"weather_summary": string(`Today in "Lisbon" is sunny`)},
}, "user"),
Expand All @@ -595,6 +595,9 @@ func TestMCPToolSetConfirmation(t *testing.T) {
confirmFunctionResponse: &genai.FunctionResponse{Name: toolconfirmation.FunctionCallName, Response: map[string]any{"confirmed": false}},
want: []*genai.Content{
genai.NewContentFromFunctionCall(toolName, map[string]any{"city": "Lisbon"}, "model"),
genai.NewContentFromFunctionResponse(toolName, map[string]any{
"error": errors.New("error tool \"get_weather\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionCall(toolconfirmation.FunctionCallName, map[string]any{
"originalFunctionCall": &genai.FunctionCall{
Args: map[string]any{"city": "Lisbon"},
Expand All @@ -604,9 +607,6 @@ func TestMCPToolSetConfirmation(t *testing.T) {
Hint: "Please approve or reject the tool call get_weather() by responding with a FunctionResponse with an expected ToolConfirmation payload.",
},
}, "model"),
genai.NewContentFromFunctionResponse(toolName, map[string]any{
"error": errors.New("error tool \"get_weather\" requires confirmation, please approve or reject"),
}, "user"),
genai.NewContentFromFunctionResponse(toolName, map[string]any{
"error": errors.New("error tool \"get_weather\" call is rejected"),
}, "user"),
Expand Down