Freigeben über

Erstellen eines minimalen MCP-Servers mit C# und Veröffentlichen in NuGet

In dieser Schnellstartanleitung erstellen Sie einen minimalen MCP-Server (Model Context Protocol) mit dem C#SDK für MCP, stellen eine Verbindung mit dem Server mithilfe von GitHub Copilot her und veröffentlichen ihn in NuGet. MCP-Server sind Dienste, die Über das Model Context Protocol (MCP) Funktionen für Clients verfügbar machen.

Hinweis

Das Microsoft.McpServer.ProjectTemplates Vorlagenpaket befindet sich derzeit in der Vorschauversion.

Voraussetzungen

Erstelle das Projekt

  1. Installieren Sie in einem Terminalfenster die MCP-Servervorlage:

    dotnet new install Microsoft.McpServer.ProjectTemplates

    Hinweis

    .NET 10.0 SDK (Preview 6 oder höher) ist für die Installation Microsoft.McpServer.ProjectTemplateserforderlich.

  2. Erstellen Sie eine neue MCP-Server-App mit dem dotnet new mcpserver Befehl:

    dotnet new mcpserver -n SampleMcpServer

    Standardmäßig erstellt dieser Befehl ein eigenständiges Toolpaket für alle gängigen Plattformen, auf denen .NET unterstützt wird. Um weitere Optionen anzuzeigen, verwenden Sie dotnet new mcpserver --help.

  3. Navigieren Sie zum SampleMcpServer Verzeichnis:

    cd SampleMcpServer

  4. Erstellen Sie das Projekt:

    dotnet build

  5. Aktualisieren Sie die <PackageId> in der .csproj Datei, damit sie auf NuGet.org eindeutig ist, zum Beispiel <NuGet.org username>.SampleMcpServer.

Konfigurieren des MCP-Servers in Visual Studio Code

Konfigurieren Sie GitHub Copilot für Visual Studio Code für die Verwendung Ihres benutzerdefinierten MCP-Servers:

  1. Falls noch nicht geschehen, öffnen Sie den Projektordner in Visual Studio Code.

  2. Erstellen Sie einen .vscode Ordner im Stammverzeichnis Ihres Projekts.

  3. Fügen Sie eine mcp.json.vscode Datei im Ordner mit dem folgenden Inhalt hinzu:

    {
  "servers": {
    "SampleMcpServer": {
      "type": "stdio",
      "command": "dotnet",
      "args": [
        "run",
        "--project",
        "<relative-path-to-project-file>"
      ]
    }
  }
}

    Hinweis

    VS Code führt MCP-Server vom Arbeitsbereichsstamm aus. Der <relative-path-to-project-file> Platzhalter sollte auf Ihre .NET-Projektdatei verweisen. Der Wert für diese SampleMcpServer-App wäre beispielsweise SampleMcpServer.csproj.

  4. Speichern Sie die Datei.

Testen des MCP-Servers

Die MCP-Server-Vorlage enthält ein Tool namens get_random_number, das Sie zum Testen und als Ausgangspunkt für die Entwicklung verwenden können.

  1. Öffnen Sie GitHub Copilot in Visual Studio Code, und wechseln Sie zum Agentmodus.

  2. Wählen Sie das Symbol "Tools auswählen " aus, um zu überprüfen, ob Ihr SampleMcpServer mit dem aufgeführten Beispieltool verfügbar ist.

    Screenshot der verfügbaren MCP-Tools.

  3. Geben Sie eine Eingabeaufforderung ein, um das get_random_number Tool auszuführen:

    Give me a random number between 1 and 100.

  4. GitHub Copilot fordert die Berechtigung an, das get_random_number Tool für Ihre Aufforderung auszuführen. Wählen Sie "Weiter" aus, oder verwenden Sie den Pfeil, um ein spezifisches Verhalten auszuwählen:

    • Die aktuelle Sitzung führt immer den Vorgang in der aktuellen GitHub Copilot Agent Mode-Sitzung aus.
    • Der aktuelle Arbeitsbereich führt immer den Befehl für den aktuellen Visual Studio Code-Arbeitsbereich aus.
    • Immer erlauben legt fest, dass der Vorgang immer für jede GitHub Copilot-Agentenmodus-Sitzung oder jeden beliebigen Visual Studio Code-Arbeitsbereich ausgeführt wird.

  5. Stellen Sie sicher, dass der Server mit einer Zufallszahl antwortet:

    Your random number is 42.

Hinzufügen von Eingaben und Konfigurationsoptionen

In diesem Beispiel verbessern Sie den MCP-Server, um einen Konfigurationswert zu verwenden, der in einer Umgebungsvariablen festgelegt ist. Dies kann für das Funktionieren Ihres MCP-Servers erforderlich sein, wie ein API-Schlüssel, ein Endpunkt zum Herstellen einer Verbindung oder ein lokaler Verzeichnispfad.

  1. Fügen Sie nach der Methode GetRandomNumber eine weitere Toolmethode hinzu in Tools/RandomNumberTools.cs. Aktualisieren Sie den Toolcode, um eine Umgebungsvariable zu verwenden.

    [McpServerTool]
[Description("Describes random weather in the provided city.")]
public string GetCityWeather(
    [Description("Name of the city to return weather for")] string city)
{
    // Read the environment variable during tool execution.
    // Alternatively, this could be read during startup and passed via IOptions dependency injection
    var weather = Environment.GetEnvironmentVariable("WEATHER_CHOICES");
    if (string.IsNullOrWhiteSpace(weather))
    {
        weather = "balmy,rainy,stormy";
    }

    var weatherChoices = weather.Split(",");
    var selectedWeatherIndex =  Random.Shared.Next(0, weatherChoices.Length);

    return $"The weather in {city} is {weatherChoices[selectedWeatherIndex]}.";
}

  2. Aktualisieren Sie das .vscode/mcp.json zur Konfiguration der WEATHER_CHOICES-Umgebungsvariable für Testzwecke.

    {
   "servers": {
     "SampleMcpServer": {
       "type": "stdio",
       "command": "dotnet",
       "args": [
         "run",
         "--project",
         "<relative-path-to-project-file>"
       ],
       "env": {
          "WEATHER_CHOICES": "sunny,humid,freezing"
       }
     }
   }
 }

  3. Probieren Sie eine weitere Eingabeaufforderung mit Copilot in VS Code aus, z. B.:

    What is the weather in Redmond, Washington?

    VS Code sollte eine zufällige Wetterbeschreibung zurückgeben.

  4. Aktualisieren Sie das .mcp/server.json, um Ihre Umgebungsvariable input zu deklarieren. Das server.json Dateischema wird vom MCP-Registrierungsprojekt definiert und von NuGet.org zum Generieren der VS Code MCP-Konfiguration verwendet.

    • Verwenden Sie die environmentVariables Eigenschaft, um Umgebungsvariablen zu deklarieren, die von Ihrer App verwendet werden, die vom Client mithilfe des MCP-Servers (z. B. VS Code) festgelegt werden.

    • Verwenden Sie die packageArguments Eigenschaft, um CLI-Argumente zu definieren, die an Ihre App übergeben werden. Weitere Beispiele finden Sie im MCP Registry-Projekt.

    {
  "$schema": "https://static.modelcontextprotocol.io/schemas/2025-10-17/server.schema.json",
  "description": "<your description here>",
  "name": "io.github.<your GitHub username here>/<your repo name>",
  "version": "<your package version here>",
  "packages": [
    {
      "registryType": "nuget",
      "registryBaseUrl": "https://api.nuget.org",
      "identifier": "<your package ID here>",
      "version": "<your package version here>",
      "transport": {
        "type": "stdio"
      },
      "packageArguments": [],
      "environmentVariables": [
        {
          "name": "WEATHER_CHOICES",
          "value": "{weather_choices}",
          "variables": {
            "weather_choices": {
              "description": "Comma separated list of weather descriptions to randomly select.",
              "isRequired": true,
              "isSecret": false
            }
          }
        }
      ]
    }
  ],
  "repository": {
    "url": "https://github.com/<your GitHub username here>/<your repo name>",
    "source": "github"
  }
}

    Die einzigen Informationen, die von NuGet.org in der server.json verwendet werden, sind das erste packages Arrayelement, dessen registryType Wert mit nuget übereinstimmt. Abgesehen von der packages-Eigenschaft werden die anderen Eigenschaften auf oberster Ebene derzeit nicht verwendet und sind für die anstehende zentrale MCP-Registrierung vorgesehen. Sie können die Platzhalterwerte beibehalten, bis die MCP-Registrierung live ist und bereit ist, MCP-Servereinträge zu akzeptieren.

Sie können den MCP-Server erneut testen , bevor Sie fortfahren.

Packen und Veröffentlichen in NuGet

  1. Packen Sie das Projekt:

    dotnet pack -c Release

    Dieser Befehl erzeugt ein Toolpaket und mehrere plattformspezifische Pakete basierend auf der <RuntimeIdentifiers> Liste in SampleMcpServer.csproj.

  2. Veröffentlichen Sie die Pakete in NuGet:

    dotnet nuget push bin/Release/*.nupkg --api-key <your-api-key> --source https://api.nuget.org/v3/index.json

    Stellen Sie sicher, dass Sie alle .nupkg Dateien veröffentlichen, um sicherzustellen, dass jede unterstützte Plattform den MCP-Server ausführen kann.

    Wenn Sie den Veröffentlichungsfluss vor der Veröffentlichung in NuGet.org testen möchten, können Sie ein Konto in der NuGet Gallery-Integrationsumgebung registrieren: https://int.nugettest.org Der push Befehl würde geändert werden in:

    dotnet nuget push bin/Release/*.nupkg --api-key <your-api-key> --source https://apiint.nugettest.org/v3/index.json

Weitere Informationen finden Sie unter Veröffentlichen eines Pakets.

Entdecken Sie MCP-Server auf NuGet.org

  1. Suchen Sie nach Ihrem MCP-Serverpaket auf NuGet.org (oder int.nugettest.org , wenn Sie in der Integrationsumgebung veröffentlicht haben), und wählen Sie es aus der Liste aus.

    Screenshot einer Suche nach MCP-Servern auf NuGet.org.

  2. Zeigen Sie die Paketdetails an, und kopieren Sie den JSON von der Registerkarte "MCP-Server".

    Screenshot eines bestimmten MCP-Servers, der auf NuGet.org angezeigt wird.

  3. Fügen Sie in Ihrer mcp.json Datei im .vscode Ordner den kopierten JSON-Code hinzu, der wie folgt aussieht:

    {
  "inputs": [
    {
      "type": "promptString",
      "id": "weather_choices",
      "description": "Comma separated list of weather descriptions to randomly select.",
      "password": false
    }
  ],
  "servers": {
    "Contoso.SampleMcpServer": {
      "type": "stdio",
      "command": "dnx",
      "args": ["Contoso.SampleMcpServer@0.0.1-beta", "--yes"],
      "env": {
        "WEATHER_CHOICES": "${input:weather_choices}"
      }
    }
  }
}

    Wenn Sie in der NuGet Gallery Integration Umgebung veröffentlicht haben, müssen Sie "--add-source", "https://apiint.nugettest.org/v3/index.json" am Ende des "args" Arrays hinzufügen.

  4. Speichern Sie die Datei.

  5. Wählen Sie in GitHub Copilot das Symbol " Tools auswählen " aus, um zu überprüfen, ob Ihr SampleMcpServer mit den aufgelisteten Tools verfügbar ist.

  6. Geben Sie eine Eingabeaufforderung ein, um das neue get_city_weather Tool auszuführen:

    What is the weather in Redmond?

  7. Wenn Sie Ihrem MCP-Server Eingaben hinzugefügt haben (z. B. WEATHER_CHOICES), werden Sie aufgefordert, Werte anzugeben.

  8. Überprüfen Sie, ob der Server mit dem zufälligen Wetter reagiert:

    The weather in Redmond is balmy.

Häufig auftretende Probleme

Der Befehl "dnx" zum Ausführen von SampleMcpServer wurde nicht gefunden.

Wenn vs Code diesen Fehler beim Starten des MCP-Servers anzeigt, müssen Sie eine kompatible Version des .NET SDK installieren.

Screenshot des fehlenden dnx-Befehls in VS Code.

Der dnx Befehl wird ab Version 10 als Teil des .NET SDK ausgeliefert. Installieren Sie das .NET 10 SDK , um dieses Problem zu beheben.

GitHub Copilot verwendet Ihr Tool nicht (eine Antwort wird bereitgestellt, ohne Ihr Tool aufvozieren zu müssen)

Im Allgemeinen wird ein KI-Agent wie GitHub Copilot informiert, dass er über einige Tools verfügt, die von der Clientanwendung verfügbar sind, z. B. VS Code. Einige Tools, z. B. das Stichprobentool für Zufallszahlen, werden möglicherweise nicht vom KI-Agent genutzt, da es ähnliche Funktionen bereits integriert hat.

Wenn Ihr Tool nicht verwendet wird, überprüfen Sie Folgendes:

  1. Stellen Sie sicher, dass Ihr Tool in der Liste der Tools angezeigt wird, die VS Code aktiviert hat. Sehen Sie sich den Screenshot im Test des MCP-Servers an, um dies zu überprüfen.
  2. Verweisen Sie explizit auf den Namen des Tools in Ihrer Eingabeaufforderung. In VS Code können Sie auf Ihr Tool anhand des Namens verweisen. Beispiel: Using #get_random_weather, what is the weather in Redmond?.
  3. Überprüfen Sie, ob der MCP-Server gestartet werden kann. Sie können dies überprüfen, indem Sie in den VS Code-Benutzer- oder Arbeitsbereichseinstellungen auf die Schaltfläche "Start" klicken, die oberhalb der MCP-Serverkonfiguration angezeigt wird.

Screenshot eines MCP-Servers in der VS-Codekonfiguration, der gestartet wird.

Verwandte Inhalte

  • Last updated on