Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
20cc59b
Start on MCP server template
joelverhagen Jun 26, 2025
38d446e
Merge branch 'main' into jver/mcp-template
joelverhagen Jun 26, 2025
5ef5c50
Improve
joelverhagen Jun 26, 2025
8b06c6f
Update src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/Mcp…
joelverhagen Jun 26, 2025
cd6a0e2
Update src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/Mcp…
joelverhagen Jun 26, 2025
36c90b1
Update src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/Mcp…
joelverhagen Jun 26, 2025
5935e56
Update src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/Mcp…
joelverhagen Jun 26, 2025
4127955
Update src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/Mcp…
joelverhagen Jun 26, 2025
28363b4
Update src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/Mcp…
joelverhagen Jun 26, 2025
4e64775
Update src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/Mcp…
joelverhagen Jun 26, 2025
a2ac345
Fix type, improve readme
joelverhagen Jun 26, 2025
06d2247
Update src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/Mcp…
joelverhagen Jun 30, 2025
3a6a3e8
Address comments
joelverhagen Jul 1, 2025
fb056fc
Make package path consistent
joelverhagen Jul 1, 2025
7963103
Merge remote-tracking branch 'origin/jver/mcp-template' into jver/mcp…
joelverhagen Jul 1, 2025
21e8563
Merge remote-tracking branch 'origin/main' into jver/mcp-template
joelverhagen Jul 1, 2025
6e30470
Add icon
joelverhagen Jul 1, 2025
a98b37e
Add snapshot tests for MCP server template
joelverhagen Jul 1, 2025
129faff
Remove return 0
joelverhagen Jul 1, 2025
6be6521
Added comment
joelverhagen Jul 1, 2025
5e9d6f0
Address most of the comments
joelverhagen Jul 1, 2025
eabb037
Address comments
joelverhagen Jul 1, 2025
e29a101
Remove comment that is wrong ☠️
joelverhagen Jul 1, 2025
9b8a767
Address comment
joelverhagen Jul 1, 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
8 changes: 8 additions & 0 deletions src/ProjectTemplates/GeneratedContent.targets
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
<_LocalChatTemplateVariant>aspire</_LocalChatTemplateVariant>

<_ChatWithCustomDataContentRoot>$(MSBuildThisFileDirectory)Microsoft.Extensions.AI.Templates\src\ChatWithCustomData\</_ChatWithCustomDataContentRoot>
<_McpServerContentRoot>$(MSBuildThisFileDirectory)Microsoft.Extensions.AI.Templates\src\McpServer\</_McpServerContentRoot>
</PropertyGroup>

<Target Name="ComputeGeneratedContentProperties">
Expand All @@ -34,9 +35,11 @@
<TemplatePackageVersion_AzureIdentity>1.14.0</TemplatePackageVersion_AzureIdentity>
<TemplatePackageVersion_AzureSearchDocuments>11.6.0</TemplatePackageVersion_AzureSearchDocuments>
<TemplatePackageVersion_CommunityToolkitAspire>9.4.1-beta.291</TemplatePackageVersion_CommunityToolkitAspire>
<TemplatePackageVersion_MicrosoftExtensionsHosting>10.0.0-preview.5.25277.114</TemplatePackageVersion_MicrosoftExtensionsHosting>
<TemplatePackageVersion_MicrosoftExtensionsServiceDiscovery>9.3.0</TemplatePackageVersion_MicrosoftExtensionsServiceDiscovery>
<TemplatePackageVersion_MicrosoftSemanticKernel>1.53.0</TemplatePackageVersion_MicrosoftSemanticKernel>
<TemplatePackageVersion_MicrosoftSemanticKernel_Preview>1.53.0-preview</TemplatePackageVersion_MicrosoftSemanticKernel_Preview>
<TemplatePackageVersion_ModelContextProtocol>0.3.0-preview.1</TemplatePackageVersion_ModelContextProtocol>
<TemplatePackageVersion_OllamaSharp>5.1.18</TemplatePackageVersion_OllamaSharp>
<TemplatePackageVersion_OpenTelemetry>1.12.0</TemplatePackageVersion_OpenTelemetry>
<TemplatePackageVersion_PdfPig>0.1.10</TemplatePackageVersion_PdfPig>
Expand Down Expand Up @@ -64,9 +67,11 @@
TemplatePackageVersion_AzureIdentity=$(TemplatePackageVersion_AzureIdentity);
TemplatePackageVersion_AzureSearchDocuments=$(TemplatePackageVersion_AzureSearchDocuments);
TemplatePackageVersion_CommunityToolkitAspire=$(TemplatePackageVersion_CommunityToolkitAspire);
TemplatePackageVersion_MicrosoftExtensionsHosting=$(TemplatePackageVersion_MicrosoftExtensionsHosting);
TemplatePackageVersion_MicrosoftExtensionsServiceDiscovery=$(TemplatePackageVersion_MicrosoftExtensionsServiceDiscovery);
TemplatePackageVersion_MicrosoftSemanticKernel=$(TemplatePackageVersion_MicrosoftSemanticKernel);
TemplatePackageVersion_MicrosoftSemanticKernel_Preview=$(TemplatePackageVersion_MicrosoftSemanticKernel_Preview);
TemplatePackageVersion_ModelContextProtocol=$(TemplatePackageVersion_ModelContextProtocol);
TemplatePackageVersion_OllamaSharp=$(TemplatePackageVersion_OllamaSharp);
TemplatePackageVersion_OpenTelemetry=$(TemplatePackageVersion_OpenTelemetry);
TemplatePackageVersion_PdfPig=$(TemplatePackageVersion_PdfPig);
Expand Down Expand Up @@ -100,6 +105,9 @@
<GeneratedContent
Include="$(_ChatWithCustomDataContentRoot)ChatWithCustomData-CSharp.ServiceDefaults\ChatWithCustomData-CSharp.ServiceDefaults.csproj.in"
OutputPath="$(_ChatWithCustomDataContentRoot)ChatWithCustomData-CSharp.ServiceDefaults\ChatWithCustomData-CSharp.ServiceDefaults.csproj" />
<GeneratedContent
Include="$(_McpServerContentRoot)McpServer-CSharp\McpServer-CSharp.csproj.in"
OutputPath="$(_McpServerContentRoot)McpServer-CSharp\McpServer-CSharp.csproj" />

<!-- The following content only gets generated when using just-built packages -->
<_GeneratedContentEnablingJustBuiltPackages
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<ItemGroup>
<!-- Keep the exclude patterns below in sync with those in AIChatWebSnapshotTests.cs -->
<Content
Include="src\ChatWithCustomData\**\*"
Include="src\*\**\*"
Exclude="
**\bin\**;
**\obj\**;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"description": "<your description here>",
"name": "io.github.<your GitHub username here>/<your repo name>",
"packages": [
{
"registry_name": "nuget",
"name": "<your package ID here>",
"version": "0.1.0-beta",
"package_arguments": [
{
"description": "Start the MCP server tool in server mode",
"is_required": true,
"format": "string",
"value": "start-mcp",
"default": "start-mcp",
"type": "positional",
"value_hint": "start-mcp"
}
],
"environment_variables": [
{
"description": "The maximum number to return from the random number generator",
"name": "MAX_RANDOM_NUMBER"
}
]
}
],
"repository": {
"url": "https://github.com/<your GitHub username here>/<your repo name>",
"source": "github"
},
"version_detail": {
"version": "0.1.0-beta"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://json.schemastore.org/dotnetcli.host",
"symbolInfo": {},
"usageExamples": [
""
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "https://json.schemastore.org/ide.host",
"symbolInfo": []
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"$schema": "http://json.schemastore.org/template",
"author": "Microsoft",
"classifications": [ "Common", "AI", "MCP" ],
"identity": "Microsoft.Extensions.AI.Templates.McpServer.CSharp",
"name": "Local MCP Server Console App",
"description": "A project template for creating a local MCP server using the .NET MCP SDK.",
"shortName": "mcpserver",
"defaultName": "McpServer",
"sourceName": "McpServer-CSharp",
"preferNameDirectory": true,
"tags": {
"language": "C#",
"type": "project"
},
"primaryOutputs": [
{
"path": "./McpServer-CSharp.csproj"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<OutputType>Exe</OutputType>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>

<!-- Set up the NuGet package to be an MCP server -->
<PackAsTool>true</PackAsTool>
<PackageType>McpServer</PackageType>

<!-- Set recommended package metadata -->
<PackageReadmeFile>README.md</PackageReadmeFile>
<PackageId>SampleMcpServer</PackageId>
<PackageVersion>0.1.0-beta</PackageVersion>
<PackageTags>AI; MCP; server; stdio</PackageTags>
<Description>An MCP server using the .NET MCP SDK.</Description>
</PropertyGroup>


<!-- Include additional files for browing the MCP server. -->
<ItemGroup>
<None Include=".mcp/server.json" Pack="true" PackagePath="/.mcp" />
<None Include="README.md" Pack="true" PackagePath="/" />
</ItemGroup>

<ItemGroup>
<PackageReference Include="Microsoft.Extensions.Hosting" Version="${TemplatePackageVersion_MicrosoftExtensionsHosting}" />
<PackageReference Include="ModelContextProtocol" Version="${TemplatePackageVersion_ModelContextProtocol}" />
</ItemGroup>

</Project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using ModelContextProtocol.Server;
using System.ComponentModel;

var builder = Host.CreateApplicationBuilder(args);

if (args.Length == 0 || args[0] != "start-mcp")
{
Console.Error.WriteLine("Error: invalid command. Use the 'start-mcp' command like argument to start the MCP server.");
return 1;
}

var maxNumberEnv = Environment.GetEnvironmentVariable("MAX_RANDOM_NUMBER");
if (!int.TryParse(maxNumberEnv, out var maxNumber) || maxNumber <= 0)
{
Console.Error.WriteLine("Error: you must set the MAX_RANDOM_NUMBER environment variable to a positive integer.");
return 1;
}

builder.Logging.AddConsole(consoleLogOptions =>
{
// configure all logs to go to stderr
// stdout is used for the MCP protocol messages
consoleLogOptions.LogToStandardErrorThreshold = LogLevel.Trace;
});

// add the MCP services, discover tools from the current assembly
builder.Services
.AddMcpServer()
.WithStdioServerTransport()
.WithToolsFromAssembly();

// add dependencies for the MCP server tools
builder.Services.AddTransient(_ => new RandomNumberService(maxNumber));

await builder.Build().RunAsync();
return 0;

public class RandomNumberService(int max)
{
public int Max => max;
public int GetRandomNumber() => Random.Shared.Next(1, max + 1);
}

[McpServerToolType]
public class RandomNumberTool(RandomNumberService service)
{
[McpServerTool, Description("Returns the maximum random number that can be generated by the tool.")]
public int MaxRandomNumber()
{
return service.Max;
}

[McpServerTool, Description("Returns a random number between 1 and the maximum number set by the tool.")]
public int GetRandomNumber()
{
return service.GetRandomNumber();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# MCP Server

This README was created using the .NET MCP server template project. It demonstrates how you can easily create an MCP server using .NET and then package it in a NuGet package.

See [aka.ms/nuget/mcp/guide](https://aka.ms/nuget/mcp/guide) for the full guide.

## Checklist before publishing to NuGet.org

- Update package metadata in the .csproj file
- Update the `.mcp/server.json` to declare your MCP server's inputs
- Test the MCP server locally using the steps below

## Developing locally

To test this MCP server from source code (locally) without using a built MCP server package, use the following MCP configuration in VS Code. See [Use MCP servers in VS Code (Preview)](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more information about using MCP servers in VS Code.

```json
{
"mcp": {
"servers": {
"my-custom-mcp": {
"type": "stdio",
"command": "dotnet",
"args": [
"run",
"--project",
"<PATH TO PROJECT DIRECTORY>",
"--",
"start-mcp"
],
"env": {
"MAX_RANDOM_NUMBER": 100
}
}
}
}
}
```

Then ask the Copilot chat for a random number. It should prompt to use the `GetRandomNumber` tool on the `my-custom-mcp` MCP server.
Loading