Skip to content

.NET: Propagate FunctionResult.Metadata to AgentRole.Tool ChatMessageContent.Metadata #13855

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
gmtorres wants to merge 3 commits into
base: main
Choose a base branch
from
+50 −0
Open

.NET: Propagate FunctionResult.Metadata to AgentRole.Tool ChatMessageContent.Metadata #13855

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
efb5b90
Propagate FunctionResult Metadata to Tool ChatMessageContent
gmtorres Apr 9, 2026
48757b6
Add test
gmtorres Apr 9, 2026
c6e397a
Address comment
gmtorres Apr 9, 2026
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
2 changes: 1 addition & 1 deletion dotnet/src/InternalUtilities/connectors/AI/FunctionCalling/FunctionCallsProcessor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ await this.OnAutoFunctionInvocationAsync(
/// <param name="resultContext">The function result context.</param>
private void AddFunctionCallResultToChatHistory(ChatHistory chatHistory, FunctionResultContext resultContext)
{
var message = new ChatMessageContent(role: AuthorRole.Tool, content: resultContext.Result);
var message = new ChatMessageContent(role: AuthorRole.Tool, content: resultContext.Result, metadata: resultContext.Context.Result.Metadata);
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Passing metadata to the constructor causes the Content setter (called inside the constructor after this.Metadata is already set) to forward the same metadata to the auto-created TextContent item via new TextContent(metadata: this.Metadata). Function-result metadata doesn't belong on the text item. Assign Metadata after construction to avoid this leakage.

Suggested change
var message = new ChatMessageContent(role: AuthorRole.Tool, content: resultContext.Result, metadata: resultContext.Context.Result.Metadata);
var message = new ChatMessageContent(role: AuthorRole.Tool, content: resultContext.Result);
message.Metadata = resultContext.Context.Result.Metadata;

Copy link
Copy Markdown
Author

@gmtorres gmtorres Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, addressed

message.Items.Add(this.GenerateResultContent(resultContext));
chatHistory.Add(message);
}
Expand Down
49 changes: 49 additions & 0 deletions dotnet/src/SemanticKernel.UnitTests/Utilities/AIConnectors/FunctionCallsProcessorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using System.Threading;
Expand Down Expand Up @@ -855,6 +856,54 @@ public void ItShouldSerializeFunctionResultsWithStringProperties()
Assert.Equal("{\"Text\":\"ﾃｽﾄ\"}", result);
}

[Fact]
public async Task ItShouldPropagateFunctionResultMetadataToChatHistoryAsync()
{
// Arrange
var expectedMetadata = new Dictionary<string, object?>
{
["key1"] = "value1",
["key2"] = 42
};

var function1 = KernelFunctionFactory.CreateFromMethod((string parameter) => parameter, "Function1");
var plugin = KernelPluginFactory.CreateFromFunctions("MyPlugin", [function1]);

var kernel = CreateKernel(plugin, async (context, next) =>
{
await next(context);

// Filter sets metadata on the FunctionResult
context.Result = new FunctionResult(context.Function, context.Result.GetValue<object>(), context.Result.Culture, expectedMetadata);
});

var chatMessageContent = new ChatMessageContent();
chatMessageContent.Items.Add(new FunctionCallContent("Function1", "MyPlugin", arguments: new KernelArguments() { ["parameter"] = "function1-result" }));

var chatHistory = new ChatHistory();

// Act
await this._sut.ProcessFunctionCallsAsync(
chatMessageContent: chatMessageContent,
executionSettings: this._promptExecutionSettings,
chatHistory: chatHistory,
requestIndex: 0,
checkIfFunctionAdvertised: (_) => true,
options: this._functionChoiceBehaviorOptions,
kernel: kernel!,
isStreaming: false,
cancellationToken: CancellationToken.None);

// Assert
Assert.Equal(2, chatHistory.Count);

var toolMessage = chatHistory[1]; // First is the assistant message, second is the tool result
Assert.Equal(AuthorRole.Tool, toolMessage.Role);
Assert.NotNull(toolMessage.Metadata);
Assert.Equal("value1", toolMessage.Metadata["key1"]);
Assert.Equal(42, toolMessage.Metadata["key2"]);
}

[Fact]
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The test only covers the case where metadata is explicitly set by a filter. Consider adding analogous test without the filter (or with a no-op filter) to assert that toolMessage.Metadata is null when no metadata is provided, validating the change doesn't regress default behavior.

Suggested change
[Fact]

public async Task ItShouldPassPromptExecutionSettingsToAutoFunctionInvocationFilterAsync()
{
Expand Down
Loading