Freigeben über


Verfügbarmachen der REST-API in der API-Verwaltung als MCP-Server

GILT FÜR: Basic | Standard | Premium

In der API-Verwaltung können Sie eine REST-API verfügbar machen, die in der API-Verwaltung als MCP-Server (Remote Model Context Protocol) verwaltet wird. Machen Sie einen oder mehrere API-Vorgänge als Tools verfügbar, die MCP-Clients mithilfe des MCP-Protokolls aufrufen können.

Die Verwendung der API-Verwaltung zum Verfügbarmachen von Remote-MCP-Servern bietet eine zentrale Kontrolle über Authentifizierung, Autorisierung und Überwachung. Es vereinfacht den Prozess der Bereitstellung von APIs als MCP-Server und trägt dazu bei, häufige Sicherheitsrisiken zu minimieren und die Skalierbarkeit zu gewährleisten.

Hinweis

Diese Funktion steht derzeit als Vorschau zur Verfügung. Es wird zuerst für die KI Gateway EarlyUpdate Gruppe freigegeben. Nach dem Beitritt zur Gruppe kann es 2 Stunden dauern, bis auf MCP-Serverfunktionen zugegriffen wird.

In diesem Artikel erfahren Sie, wie Sie:

  • Verfügbarmachen einer REST-API in der API-Verwaltung als MCP-Server
  • Konfigurieren von Richtlinien für den MCP-Server
  • Testen des generierten MCP-Servers von einem MCP-Client

Informationen zu MCP-Servern

KI-Agents werden aufgrund erweiterter LLM-Funktionen (Large Language Model) weit verbreitet. Selbst die fortschrittlichsten Modelle sehen sich aufgrund ihrer Isolation von externen Daten jedoch mit Einschränkungen konfrontiert. Jede neue Datenquelle erfordert möglicherweise benutzerdefinierte Implementierungen, um Daten für die Modelle zu extrahieren, vorzubereiten und zugänglich zu machen.

Das Modellkontextprotokoll (MCP) hilft bei der Lösung dieses Problems. MCP ist ein offener Standard zum Verbinden von KI-Modellen und Agents mit externen Datenquellen wie lokalen Datenquellen (Datenbanken oder Computerdateien) oder Remotediensten (Systeme, die über das Internet verfügbar sind, z. B. Remotedatenbanken oder APIs).

MCP-Architektur

Das folgende Diagramm veranschaulicht die MCP-Architektur:

Diagramm der MCP-Architektur (Model Context Protocol).

Die Architektur umfasst die folgenden Komponenten:

Komponente BESCHREIBUNG
MCP-Hosts LLM-Anwendungen wie Chat-Apps oder KI-Assistenten in Ihren IDEs (z. B. GitHub Copilot in Visual Studio Code), die auf externe Funktionen zugreifen müssen
MCP-Clients Protokollclients innerhalb der Hostanwendung, die 1:1-Verbindungen mit Servern verwalten
MCP-Server Einfache Programme, die jeweils bestimmte Funktionen verfügbar machen und Kontext, Tools und Eingabeaufforderungen für Clients bereitstellen
MCP-Protokoll Transportschicht in der Mitte

MCP folgt einer Clientserverarchitektur, in der eine Hostanwendung eine Verbindung mit mehreren Servern herstellen kann. Wenn Ihr MCP-Host oder -Client ein Tool benötigt, stellt er eine Verbindung mit dem MCP-Server bereit. Der MCP-Server stellt dann eine Verbindung mit einer Datenbank oder einer API bereit. MCP-Hosts und -Server verbinden sich über das MCP-Protokoll miteinander.

Remote- und lokale MCP-Server

MCP verwendet eine Clienthostserverarchitektur, die auf JSON-RPC 2.0 für Messaging basiert. Die Kommunikation zwischen Clients und Servern erfolgt über definierte Transportebenen und unterstützt in erster Linie zwei Betriebsmodi:

  • Remote-MCP-Server – MCP-Clients stellen eine Verbindung mit MCP-Servern über das Internet her, einrichten eine Verbindung mit HTTP- und servergesendeten Ereignissen (SSE) und Autorisieren des MCP-Clientzugriffs auf Ressourcen im Konto des Benutzers mithilfe von OAuth.

  • Lokale MCP-Server MCP-Clients stellen eine Verbindung mit MCP-Servern auf demselben Computer her, wobei die Standardeingabe/Ausgabe als lokale Transportmethode verwendet wird.

Voraussetzungen

  • Schließen Sie den folgenden Schnellstart ab: Erstellen einer Azure API Management-Instanz Derzeit unterstützen nur die Ebenen Premium, Standard und Basic der API-Verwaltung MCP-Server.
  • Stellen Sie sicher, dass Ihre Instanz eine REST-API verwaltet, die Sie als MCP-Server verfügbar machen möchten. Informationen zum Importieren einer Beispiel-API finden Sie unter Importieren und Veröffentlichen Ihrer ersten API.

    Hinweis

    Nur HTTP-APIs aus der API-Verwaltung können als MCP-Server verfügbar gemacht werden.

  • Zum Testen des MCP-Servers können Sie Visual Studio Code mit Zugriff auf GitHub Copilot verwenden.

Verfügbarmachen der API als MCP-Server

  1. Greifen Sie im Azure-Portal auf die MCP-Servervorschau unter der folgenden URL zu:

    https://portal.azure.com/?Microsoft_Azure_ApiManagement=mcp
    
  2. Navigieren Sie zu Ihrer API Management-Instanz.

  3. Wählen Sie im linken Menü APIs>MCP-Server>+ Neuen MCP-Server erstellen aus.

  4. Wählen Sie in der API eine REST-API aus, die als MCP-Server verfügbar gemacht werden soll.

  5. Wählen Sie einen oder mehrere API-Vorgänge aus, die als Tools verfügbar gemacht werden sollen. Sie können alle Vorgänge oder nur bestimmte Vorgänge auswählen.

  6. Wählen Sie "Erstellen" aus.

Screenshot des Erstellens eines MCP-Servers im Portal.

Der MCP-Server wird erstellt, und die API-Vorgänge werden als Tools verfügbar gemacht. Der MCP-Server wird im BEREICH "MCP-Server " aufgeführt. In der URL-Spalte wird der Endpunkt des MCP-Servers angezeigt, den Sie zum Testen oder innerhalb einer Clientanwendung aufrufen können.

Screenshot der MCP-Serverliste im Portal.

Konfigurieren von Richtlinien für den MCP-Server

Konfigurieren Sie eine oder mehrere API-Verwaltungsrichtlinien , um den MCP-Server zu verwalten. Die Richtlinien werden auf alle API-Vorgänge angewendet, die als Tools auf dem MCP-Server verfügbar gemacht werden, und können verwendet werden, um den Zugriff, die Authentifizierung und andere Aspekte der Tools zu steuern.

Ein Lernprogramm zum Konfigurieren von Richtlinien finden Sie unter Transformieren und Schützen Ihrer API.

So konfigurieren Sie Richtlinien für den MCP-Server:

  1. Wählen Sie im Portal unter APIsMCP-Server aus.

  2. Wählen Sie den von Ihnen erstellten MCP-Server aus.

  3. Wählen Sie im linken Menü unter MCP die Option "Richtlinien" aus.

  4. Fügen Sie im Richtlinien-Editor die Richtlinien hinzu, die Sie auf die Tools des MCP-Servers anwenden möchten, oder bearbeiten Sie sie. Die Richtlinien werden im XML-Format definiert. Sie können z. B. eine Richtlinie hinzufügen, um Aufrufe an die Tools des MCP-Servers einzuschränken (in diesem Beispiel 5 Anrufe pro 30 Sekunden pro Client-IP-Adresse).

     <rate-limit-by-key calls="5" renewal-period="30" counter-key="@(context.Request.IpAddress)" remaining-calls-variable-name="remainingCallsPerIP" />
    

    Screenshot des Richtlinien-Editors für einen MCP-Server.

Testen und Verwenden des MCP-Servers

Um zu überprüfen, ob der MCP-Server funktioniert, können Sie Visual Studio Code verwenden, um Anforderungen an die MCP-Servertools zu senden.

Verwenden Sie in Visual Studio Code den GitHub Copilot-Chat im Agentmodus (Vorschau), um den MCP-Server hinzuzufügen und die Tools zu verwenden. Hintergrundinformationen zu MCP-Servern in Visual Studio Code finden Sie unter Verwenden von MCP-Servern in VS Code (Vorschau).

Tipp

Wenn Sie den MCP Inspector verwenden, um einen MCP-Server zu testen, der von der API-Verwaltung erstellt wurde, empfehlen wir die Verwendung von Version 0.9.0.

Hinzufügen des MCP-Servers in Visual Studio Code

So fügen Sie den MCP-Server in Visual Studio Code hinzu:

  1. Verwenden Sie den Befehl MCP: Add Server aus der Befehlspalette.

  2. Wenn Sie dazu aufgefordert werden, wählen Sie den Servertyp HTTP (HTTP- oder Server gesendete Ereignisse) aus.

  3. Geben Sie die URL des MCP-Servers in der API-Verwaltung ein. Beispiel: https://<apim-service-name>.azure-api.net/<api-name>-mcp/sse (für SSE-Endpunkt) oder https://<apim-service-name>.azure-api.net/<api-name>-mcp/mcp (für MCP-Endpunkt)

  4. Geben Sie eine Server-ID Ihrer Wahl ein.

  5. Wählen Sie aus, ob die Konfiguration in Ihren Arbeitsbereichseinstellungen oder Benutzereinstellungen gespeichert werden soll.

    • Arbeitsbereichseinstellungen – Die Serverkonfiguration wird nur in einer .vscode/mcp.json Datei gespeichert, die nur im aktuellen Arbeitsbereich verfügbar ist.

    • Benutzereinstellungen – Die Serverkonfiguration wird ihrer globalen settings.json Datei hinzugefügt und ist in allen Arbeitsbereichen verfügbar. Die Konfiguration sieht ähnlich wie folgt aus:

    Screenshot der MCP-Server, die in Visual Studio Code konfiguriert sind.

Fügen Sie der JSON-Konfiguration Felder für Einstellungen wie den Authentifizierungsheader hinzu. Das folgende Beispiel zeigt die Konfiguration für einen API-Verwaltungsabonnementschlüssel, der in einem Header als Eingabewert übergeben wird. Weitere Informationen zum Konfigurationsformat

Screenshot der Konfiguration des Authentifizierungsheaders für einen MCP-Server

Verwenden von Tools im Agentmodus

Nachdem Sie einen MCP-Server hinzugefügt haben, können Sie Tools im Agentmodus verwenden.

  1. Wählen Sie im GitHub Copilot-Chat den Agent-Modus aus, und wählen Sie die Schaltfläche "Extras " aus, um die verfügbaren Tools anzuzeigen.

    Screenshot der Schaltfläche

  2. Wählen Sie ein oder mehrere Tools vom MCP-Server aus, um im Chat verfügbar zu sein.

    Screenshot der Auswahl von Tools in Visual Studio Code.

  3. Geben Sie im Chat eine Eingabeaufforderung ein, um das Tool aufzurufen. Wenn Sie z. B. ein Tool zum Abrufen von Informationen zu einer Bestellung ausgewählt haben, können Sie den Agenten um eine Bestellung bitten.

    Get information for order 2
    

    Wählen Sie "Weiter" aus, um die Ergebnisse anzuzeigen. Der Agent verwendet das Tool, um den MCP-Server aufzurufen und die Ergebnisse im Chat zurückgibt.

    Screenshot der Chatergebnisse in Visual Studio Code.