* Overhaul tool handling
- Renames [McpTool{Type}] to [McpServerTool{Type}], in order to distinguish representations of tools on the server from tools on the client.
- Enables [McpServerTool] methods to have arguments injected from DI, as well as a specific set of types from the implementation directly, like IMcpServer.
- Renames WithTools to WithToolsFromAssembly.
- All of the WithToolsXx methods now publish each individual McpServerTool into DI; other code can do so as well. The options setup code gathers all of the tools from DI and combines them into a collection which is then stored in McpServerOptions and used to construct the server.
- The server tools specified via DI as well as manually-provided handlers, using CallToolHandler as a fallback in case the requested tool doesn't exist in the tools collection, and ListToolsHandler augments the information for whatever tools exist.
- The tools are stored in McpServerOptions in a new McpServerToolCollection type, which is a thread-safe container that exposes add/removal notification. Adding/removing tools triggers a change notification that in turn sends a notification to the client about a tools update.
- The ServerOptions are exposed from the server instance.
- Removed cursor-based APIs from McpClientExtensions.
- Changed McpClientExtensions APIs to return `Task<IList<...>` rather than `IAsyncEnumerable<...>`.
I'm sure this will need to evolve further before we're "done", but it's a significant improvement from where we are now. One area I'm not super happy with is the notifying collection; that might work ok for a stdio server, where you can grab the created collection from the server's options and mutate it, but I don't know how well that's going to work for sse servers.
* Make McpServerTool{Collection} extensible
* Fix README.md example
* Add notifications test
* Address feedback
244 lines
7.1 KiB
C#
244 lines
7.1 KiB
C#
using ModelContextProtocol.Client;
|
|
using ModelContextProtocol.Protocol.Types;
|
|
using ModelContextProtocol.Tests.Utils;
|
|
|
|
namespace ModelContextProtocol.Tests;
|
|
|
|
public class SseServerIntegrationTests : LoggedTest, IClassFixture<SseServerIntegrationTestFixture>
|
|
{
|
|
private readonly SseServerIntegrationTestFixture _fixture;
|
|
|
|
public SseServerIntegrationTests(SseServerIntegrationTestFixture fixture, ITestOutputHelper testOutputHelper)
|
|
: base(testOutputHelper)
|
|
{
|
|
_fixture = fixture;
|
|
_fixture.Initialize(testOutputHelper);
|
|
}
|
|
|
|
private Task<IMcpClient> GetClientAsync(McpClientOptions? options = null)
|
|
{
|
|
return McpClientFactory.CreateAsync(
|
|
_fixture.DefaultConfig,
|
|
options ?? _fixture.DefaultOptions,
|
|
loggerFactory: LoggerFactory);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ConnectAndPing_Sse_TestServer()
|
|
{
|
|
// Arrange
|
|
|
|
// Act
|
|
var client = await GetClientAsync();
|
|
await client.PingAsync(CancellationToken.None);
|
|
|
|
// Assert
|
|
Assert.NotNull(client);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task Connect_TestServer_ShouldProvideServerFields()
|
|
{
|
|
// Arrange
|
|
|
|
// Act
|
|
var client = await GetClientAsync();
|
|
|
|
// Assert
|
|
Assert.NotNull(client.ServerCapabilities);
|
|
Assert.NotNull(client.ServerInfo);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ListTools_Sse_TestServer()
|
|
{
|
|
// arrange
|
|
|
|
// act
|
|
var client = await GetClientAsync();
|
|
var tools = await client.ListToolsAsync(TestContext.Current.CancellationToken);
|
|
|
|
// assert
|
|
Assert.NotNull(tools);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task CallTool_Sse_EchoServer()
|
|
{
|
|
// arrange
|
|
|
|
// act
|
|
var client = await GetClientAsync();
|
|
var result = await client.CallToolAsync(
|
|
"echo",
|
|
new Dictionary<string, object?>
|
|
{
|
|
["message"] = "Hello MCP!"
|
|
},
|
|
CancellationToken.None
|
|
);
|
|
|
|
// assert
|
|
Assert.NotNull(result);
|
|
Assert.False(result.IsError);
|
|
var textContent = Assert.Single(result.Content, c => c.Type == "text");
|
|
Assert.Equal("Echo: Hello MCP!", textContent.Text);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ListResources_Sse_TestServer()
|
|
{
|
|
// arrange
|
|
|
|
// act
|
|
var client = await GetClientAsync();
|
|
|
|
IList<Resource> allResources = await client.ListResourcesAsync(TestContext.Current.CancellationToken);
|
|
|
|
// The everything server provides 100 test resources
|
|
Assert.Equal(100, allResources.Count);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadResource_Sse_TextResource()
|
|
{
|
|
// arrange
|
|
|
|
// act
|
|
var client = await GetClientAsync();
|
|
// Odd numbered resources are text in the everything server (despite the docs saying otherwise)
|
|
// 1 is index 0, which is "even" in the 0-based index
|
|
// We copied this oddity to the test server
|
|
var result = await client.ReadResourceAsync("test://static/resource/1", CancellationToken.None);
|
|
|
|
Assert.NotNull(result);
|
|
Assert.Single(result.Contents);
|
|
Assert.NotNull(result.Contents[0].Text);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadResource_Sse_BinaryResource()
|
|
{
|
|
// arrange
|
|
|
|
// act
|
|
var client = await GetClientAsync();
|
|
// Even numbered resources are binary in the everything server (despite the docs saying otherwise)
|
|
// 2 is index 1, which is "odd" in the 0-based index
|
|
// We copied this oddity to the test server
|
|
var result = await client.ReadResourceAsync("test://static/resource/2", CancellationToken.None);
|
|
|
|
Assert.NotNull(result);
|
|
Assert.Single(result.Contents);
|
|
Assert.NotNull(result.Contents[0].Blob);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ListPrompts_Sse_TestServer()
|
|
{
|
|
// arrange
|
|
|
|
// act
|
|
var client = await GetClientAsync();
|
|
var prompts = await client.ListPromptsAsync(TestContext.Current.CancellationToken);
|
|
|
|
// assert
|
|
Assert.NotNull(prompts);
|
|
Assert.NotEmpty(prompts);
|
|
// We could add specific assertions for the known prompts
|
|
Assert.Contains(prompts, p => p.Name == "simple_prompt");
|
|
Assert.Contains(prompts, p => p.Name == "complex_prompt");
|
|
}
|
|
|
|
[Fact]
|
|
public async Task GetPrompt_Sse_SimplePrompt()
|
|
{
|
|
// arrange
|
|
|
|
// act
|
|
var client = await GetClientAsync();
|
|
var result = await client.GetPromptAsync("simple_prompt", null, CancellationToken.None);
|
|
|
|
// assert
|
|
Assert.NotNull(result);
|
|
Assert.NotEmpty(result.Messages);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task GetPrompt_Sse_ComplexPrompt()
|
|
{
|
|
// arrange
|
|
|
|
// act
|
|
var client = await GetClientAsync();
|
|
var arguments = new Dictionary<string, object?>
|
|
{
|
|
{ "temperature", "0.7" },
|
|
{ "style", "formal" }
|
|
};
|
|
var result = await client.GetPromptAsync("complex_prompt", arguments, CancellationToken.None);
|
|
|
|
// assert
|
|
Assert.NotNull(result);
|
|
Assert.NotEmpty(result.Messages);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task GetPrompt_Sse_NonExistent_ThrowsException()
|
|
{
|
|
// arrange
|
|
|
|
// act
|
|
var client = await GetClientAsync();
|
|
await Assert.ThrowsAsync<McpClientException>(() =>
|
|
client.GetPromptAsync("non_existent_prompt", null, CancellationToken.None));
|
|
}
|
|
|
|
[Fact]
|
|
public async Task Sampling_Sse_TestServer()
|
|
{
|
|
// arrange
|
|
// Set up the sampling handler
|
|
int samplingHandlerCalls = 0;
|
|
#pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously
|
|
var options = _fixture.DefaultOptions with
|
|
{
|
|
Capabilities = new()
|
|
{
|
|
Sampling = new()
|
|
{
|
|
SamplingHandler = async (_, _) =>
|
|
{
|
|
samplingHandlerCalls++;
|
|
return new CreateMessageResult
|
|
{
|
|
Model = "test-model",
|
|
Role = "assistant",
|
|
Content = new Content
|
|
{
|
|
Type = "text",
|
|
Text = "Test response"
|
|
}
|
|
};
|
|
}
|
|
}
|
|
}
|
|
};
|
|
var client = await GetClientAsync(options);
|
|
#pragma warning restore CS1998 // Async method lacks 'await' operators and will run synchronously
|
|
|
|
// Call the server's sampleLLM tool which should trigger our sampling handler
|
|
var result = await client.CallToolAsync("sampleLLM", new Dictionary<string, object?>
|
|
{
|
|
["prompt"] = "Test prompt",
|
|
["maxTokens"] = 100
|
|
},
|
|
TestContext.Current.CancellationToken);
|
|
|
|
// assert
|
|
Assert.NotNull(result);
|
|
var textContent = Assert.Single(result.Content);
|
|
Assert.Equal("text", textContent.Type);
|
|
Assert.False(string.IsNullOrEmpty(textContent.Text));
|
|
}
|
|
}
|