Skip to content

Log tool invocation errors #447

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

Merged
merged 4 commits into from
May 23, 2025
Merged

Log tool invocation errors #447

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
926aacd
Log tool errors
kooshi May 23, 2025
a87c47c
add test and implement source generated logging
kooshi May 23, 2025
4e3f411
whitespace cleanup
kooshi May 23, 2025
b39aaf5
Update src/ModelContextProtocol/Server/AIFunctionMcpServerTool.cs
halter73 May 23, 2025
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
28 changes: 18 additions & 10 deletions src/ModelContextProtocol/Server/AIFunctionMcpServerTool.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
using Microsoft.Extensions.AI;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Abstractions;
using ModelContextProtocol.Protocol;
using System.ComponentModel;
using System.Diagnostics.CodeAnalysis;
Expand All @@ -11,6 +13,8 @@ namespace ModelContextProtocol.Server;
/// <summary>Provides an <see cref="McpServerTool"/> that's implemented via an <see cref="AIFunction"/>.</summary>
internal sealed class AIFunctionMcpServerTool : McpServerTool
{
private readonly ILogger _logger;

/// <summary>
/// Creates an <see cref="McpServerTool"/> instance for a method, specified via a <see cref="Delegate"/> instance.
/// </summary>
Expand All @@ -19,7 +23,7 @@ internal sealed class AIFunctionMcpServerTool : McpServerTool
McpServerToolCreateOptions? options)
{
Throw.IfNull(method);

options = DeriveOptions(method.Method, options);

return Create(method.Method, method.Target, options);
Expand Down Expand Up @@ -172,7 +176,7 @@ private static AIFunctionFactoryOptions CreateAIFunctionFactoryOptions(
{
Name = options?.Name ?? function.Name,
Description = options?.Description ?? function.Description,
InputSchema = function.JsonSchema,
InputSchema = function.JsonSchema,
};

if (options is not null)
Expand All @@ -194,7 +198,7 @@ options.OpenWorld is not null ||
}
}

return new AIFunctionMcpServerTool(function, tool);
return new AIFunctionMcpServerTool(function, tool, options?.Services);
}

private static McpServerToolCreateOptions DeriveOptions(MethodInfo method, McpServerToolCreateOptions? options)
Expand Down Expand Up @@ -239,10 +243,11 @@ private static McpServerToolCreateOptions DeriveOptions(MethodInfo method, McpSe
internal AIFunction AIFunction { get; }

/// <summary>Initializes a new instance of the <see cref="McpServerTool"/> class.</summary>
private AIFunctionMcpServerTool(AIFunction function, Tool tool)
private AIFunctionMcpServerTool(AIFunction function, Tool tool, IServiceProvider? serviceProvider)
{
AIFunction = function;
ProtocolTool = tool;
_logger = serviceProvider?.GetService<ILoggerFactory>()?.CreateLogger<AIFunctionMcpServerTool>() ?? (ILogger)NullLogger.Instance;
}

/// <inheritdoc />
Expand Down Expand Up @@ -277,6 +282,9 @@ public override async ValueTask<CallToolResponse> InvokeAsync(
}
catch (Exception e) when (e is not OperationCanceledException)
{
_logger.LogError(e, "Error invoking AIFunction tool '{ToolName}' with arguments '{Args}'.",
request.Params?.Name, string.Join(",", request.Params?.Arguments?.Keys ?? Array.Empty<string>()));

string errorMessage = e is McpException ?
$"An error occurred invoking '{request.Params?.Name}': {e.Message}" :
$"An error occurred invoking '{request.Params?.Name}'.";
Expand All @@ -300,29 +308,29 @@ public override async ValueTask<CallToolResponse> InvokeAsync(
{
Content = []
},

string text => new()
{
Content = [new() { Text = text, Type = "text" }]
},

Content content => new()
{
Content = [content]
},

IEnumerable<string> texts => new()
{
Content = [.. texts.Select(x => new Content() { Type = "text", Text = x ?? string.Empty })]
},

IEnumerable<AIContent> contentItems => ConvertAIContentEnumerableToCallToolResponse(contentItems),

IEnumerable<Content> contents => new()
{
Content = [.. contents]
},

CallToolResponse callToolResponse => callToolResponse,

_ => new()
Expand Down