Tools registered with WithTools keep a disposed service provider in memory

Open
#1,898 2 comments 0 reactions 1 assignee View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
58/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
csharp
Domain
backend

Research direction

Start by running the provided reproduction with WithTools both with and without per-app JsonSerializerOptions, then trace CreateAIFunctionFactoryOptions through AIFunctionFactory and the McpJsonUtilities.DefaultOptions cache. Done means disposed service providers become collectible in both cases, confirmed by the WeakReference and GC checks in the reproduction.

Written by the indexing model from the issue text.

Description

P2

Describe the bug

A service provider that creates its tools through WithTools or WithToolsFromAssembly stays in memory for the life of the process, even after it's disposed.

CreateAIFunctionFactoryOptions hands AIFunctionFactory a ConfigureParameterBinding lambda that captures the McpServerToolCreateOptions, and with them the Services these registrations pass in. Microsoft.Extensions.AI caches the descriptor of each tool method in a static ConditionalWeakTable keyed by the serializer options, and that lambda is part of the key of every entry. Unless serializer options are passed, they're McpJsonUtilities.DefaultOptions, which never go away. So each service provider adds entries that no later lookup can match, since the lambda is new every time, and each entry keeps its provider alive. Only the cache's limit of 512 entries puts a cap on it.

An app with a single service provider won't notice. A test project that starts an app per test does. In a dump of ours, this held 67 of the 110 disposed service providers.

To Reproduce

ModelContextProtocol 2.2.0 and Microsoft.Extensions.DependencyInjection 10.0 on net10.0:

using System.ComponentModel;
using System.Runtime.CompilerServices;
using System.Text.Json;
using Microsoft.Extensions.DependencyInjection;
using ModelContextProtocol;
using ModelContextProtocol.Server;

var ownOptions = args.Contains("--own-serializer-options");

List<WeakReference> providers = [];
for (var i = 0; i < 20; i++)
    providers.Add(await CreateAndDispose(ownOptions));

for (var i = 0; i < 3; i++)
{
    GC.Collect();
    GC.WaitForPendingFinalizers();
}

Console.WriteLine($"own serializer options: {ownOptions}, {providers.Count(p => p.IsAlive)} of {providers.Count} disposed service providers are still alive");

[MethodImpl(MethodImplOptions.NoInlining)]
static async Task<WeakReference> CreateAndDispose(bool ownOptions)
{
    var services = new ServiceCollection();

    if (ownOptions)
        services.AddMcpServer().WithTools<EchoTools>(new JsonSerializerOptions(McpJsonUtilities.DefaultOptions));
    else
        services.AddMcpServer().WithTools<EchoTools>();

    await using var provider = services.BuildServiceProvider();

    _ = provider.GetServices<McpServerTool>().ToList();

    return new WeakReference(provider);
}

[McpServerToolType]
public sealed class EchoTools
{
    [McpServerTool, Description("Echoes the message back.")]
    public string Echo(string message) => message;
}

Output:

own serializer options: False, 20 of 20 disposed service providers are still alive
own serializer options: True, 0 of 20 disposed service providers are still alive

Expected behavior

A disposed service provider can be collected, whether or not serializer options were passed.

Additional context

The path from our dump:

McpJsonUtilities.DefaultOptions
  > ConcurrentDictionary<DescriptorKey, ReflectionAIFunctionDescriptor>
  > Func<ParameterInfo, ParameterBindingOptions>
  > AIFunctionMcpServerTool+<>c__DisplayClass4_0
  > McpServerToolCreateOptions
  > ServiceProviderEngineScope

Giving each app its own copy of the serializer options, as the second run above does, works around it for now.

Dominant language
C#
Stars
4.6k
Forks
849
Avg merge
1d 16h
Merged PRs (30d)
24

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from modelcontextprotocol/csharp-sdk

All issues in modelcontextprotocol/csharp-sdk

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.