Delen via

REST API beschikbaar maken in API Management als een MCP-server

VAN TOEPASSING OP: Basic | Basic v2 | Standaard | Standard v2 | Premium | Premium v2

In API Management kunt u een REST API beschikbaar maken die wordt beheerd in API Management als een EXTERNE MCP-server (Model Context Protocol) met behulp van de ingebouwde AI-gateway. Maak een of meer API-bewerkingen beschikbaar als hulpprogramma's die MCP-clients kunnen aanroepen met behulp van het MCP-protocol.

Belangrijk

  • Deze functie is in preview en heeft enkele beperkingen.
  • Controleer de vereisten voor toegang tot MCP-serverfuncties.

Azure API Management biedt ook ondersteuning voor beveiligde integratie met bestaande MCP-compatibele servers: hulpprogrammaservers die buiten API Management worden gehost. Zie Een bestaande MCP-server beschikbaar maken voor meer informatie.

Meer informatie over:

Beperkingen

De volgende beperkingen zijn van toepassing op deze preview. Preview-functies zijn onderhevig aan wijzigingen. Controleer daarom op updates.

  • API Management biedt ondersteuning voor MCP-serverhulpprogramma's, maar biedt geen ondersteuning voor MCP-resources of -prompts.
  • MCP-servermogelijkheden worden niet ondersteund in API Management-werkruimten.

Vereiste voorwaarden

  • Als u nog geen API Management-exemplaar hebt, voltooit u de volgende quickstart: Een Azure API Management-exemplaar maken.

    • De volgende servicelagen worden ondersteund voor preview: klassieke Basic, Standard, Premium, Basic v2, Standard v2 of Premium v2.
    • In de klassieke Basic-, Standard- of Premium-laag moet u lid worden van de EARLY-updategroep van AI Gateway om toegang te krijgen tot MCP-serverfuncties. Het kan maximaal 2 uur duren voordat de update wordt toegepast.

  • Zorg ervoor dat uw exemplaar een HTTP-compatibele API beheert (elke API die is geïmporteerd als een REST API, inclusief API's die zijn geïmporteerd uit Azure-resources) die u als een MCP-server wilt weergeven. Als u een voorbeeld-API wilt importeren, raadpleeg uw eerste API importeren en publiceren.

    Opmerking

    Andere API-typen in API Management die niet compatibel zijn met HTTP, kunnen niet worden weergegeven als MCP-servers.

  • Als u diagnostische logboekregistratie hebt ingeschakeld via Application Insights of Azure Monitor op het globale bereik (alle API's) voor uw API Management-service-exemplaar, moet u ervoor zorgen dat het aantal nettoladingbytes dat moet worden ingesteld op logboekinstelling voor Front-endantwoord op 0. Dit voorkomt onbedoelde logboekregistratie van antwoordteksten in alle API's en helpt ervoor te zorgen dat MCP-servers goed werken. Om payloads selectief te registreren voor specifieke API's, configureert u de instelling afzonderlijk op de API-scope, waardoor gerichte controle over het registreren van antwoorden mogelijk is.

  • Als u de MCP-server wilt testen, kunt u Visual Studio Code gebruiken met toegang tot GitHub Copilot.

API beschikbaar maken als een MCP-server

Volg deze stappen om een beheerde REST API beschikbaar te maken in API Management als een MCP-server:

  1. Blader in Azure Portal naar uw API Management-exemplaar.
  2. Selecteer in het linkermenu onder API'sMCP-servers>+ MCP-server maken.
  3. Selecteer Een API beschikbaar maken als een MCP-server.
  4. In back-end MCP-server:
    1. Selecteer een beheerde API om beschikbaar te maken als een MCP-server.
    2. Selecteer een of meer API-bewerkingen om beschikbaar te maken als hulpprogramma's. U kunt alle bewerkingen of alleen specifieke bewerkingen selecteren.

      Opmerking

      U kunt de bewerkingen bijwerken die later worden weergegeven als hulpprogramma's op de blade Extra van uw MCP-server.

  5. In de nieuwe MCP-server:
    1. Voer een naam in voor de MCP-server in API Management.
    2. Voer desgewenst een beschrijving in voor de MCP-server.
  6. Klik op Creëren.

Schermopname van het maken van een MCP-server in de portal.

  • De MCP-server wordt gemaakt en de API-bewerkingen worden weergegeven als hulpprogramma's.
  • De MCP-server wordt weergegeven op de blade MCP-servers . De kolom Server-URL toont het eindpunt van de MCP-server die moet worden aangeroepen voor testen of binnen een clienttoepassing.

Schermopname van de lijst met MCP-servers in de portal.

Beleid configureren voor de MCP-server

Configureer een of meer API Management-beleidsregels om de MCP-server te beheren. Het beleid wordt toegepast op alle API-bewerkingen die beschikbaar worden gesteld als hulpprogramma's op de MCP-server en kunnen worden gebruikt om de toegang, verificatie en andere aspecten van de hulpprogramma's te beheren.

Meer informatie over het configureren van beleid:

Waarschuwing

Krijg geen toegang tot de hoofdtekst van het antwoord met behulp van de context.Response.Body variabele binnen MCP-serverbeleid. Als u dit doet, wordt reactiebuffering geactiveerd, waardoor het streaminggedrag dat door MCP-servers is vereist, wordt beïnvloed en kan dit leiden tot storingen.

Ga als volgende te werk om beleidsregels voor de MCP-server te configureren:

  1. Blader in Azure Portal naar uw API Management-exemplaar.

  2. Selecteer MCP-servers in het linkermenu onder API's.

  3. Selecteer een MCP-server in de lijst.

  4. Selecteer Beleid in het linkermenu onder MCP.

  5. Voeg in de beleidseditor het beleid toe of bewerk het beleid dat u wilt toepassen op de hulpprogramma's van de MCP-server. Het beleid wordt gedefinieerd in XML-indeling. U kunt bijvoorbeeld een beleid toevoegen om aanroepen te beperken tot de hulpprogramma's van de MCP-server (in dit voorbeeld 5 aanroepen per 30 seconden per CLIENT-IP-adres).

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

    Schermopname van de beleidseditor voor een MCP-server.

De MCP-server valideren en gebruiken

Gebruik een compatibele LLM-agent (zoals GitHub Copilot, Semantic Kernel of Copilot Studio) of een testclient (zoals curl) om het DOOR API Management gehoste MCP-eindpunt aan te roepen. Zorg ervoor dat de aanvraag de juiste headers of tokens bevat en controleer of de routering en het antwoord van de MCP-server is geslaagd.

Aanbeveling

Als u de MCP Inspector gebruikt om een MCP-server te testen die wordt beheerd door API Management, raden we u aan versie 0.9.0 te gebruiken.

De MCP-server toevoegen in Visual Studio Code

Gebruik in Visual Studio Code GitHub Copilot-chat in de agentmodus om de MCP-server toe te voegen en de hulpprogramma's te gebruiken. Zie MCP-servers gebruiken in VS Code voor achtergrondinformatie over MCP-servers in Visual Studio Code.

De MCP-server toevoegen in Visual Studio Code:

  1. Gebruik de opdracht MCP: Server toevoegen vanuit het opdrachtpalet.

  2. Wanneer u hierom wordt gevraagd, selecteert u het servertype: HTTP (HTTP- of Server Sent Events).

  3. Voer de server-URL van de MCP-server in API Management in. Voorbeeld: https://<apim-service-name>.azure-api.net/<api-name>-mcp/mcp (voor MCP-eindpunt)

  4. Voer een server-id van uw keuze in.

  5. Selecteer of u de configuratie wilt opslaan in uw werkruimte-instellingen of gebruikersinstellingen.

    • Werkruimte-instellingen : de serverconfiguratie wordt alleen opgeslagen in een .vscode/mcp.json bestand dat alleen beschikbaar is in de huidige werkruimte.

    • Gebruikersinstellingen : de serverconfiguratie wordt toegevoegd aan uw globale settings.json bestand en is beschikbaar in alle werkruimten. De configuratie ziet er ongeveer als volgt uit:

    Schermopname van MCP-servers die zijn geconfigureerd in Visual Studio Code.

Voeg velden toe aan de JSON-configuratie voor instellingen zoals verificatieheader. In het volgende voorbeeld ziet u de configuratie voor een API Management-sleutel die in een header als invoerwaarde is doorgegeven. Meer informatie over de configuratie-indeling

Schermopname van de configuratie van de verificatieheader voor een MCP-server

Hulpprogramma's gebruiken in agentmodus

Nadat u een MCP-server hebt toegevoegd in Visual Studio Code, kunt u hulpprogramma's gebruiken in de agentmodus.

  1. In GitHub Copilot-chat selecteert u de agentmodus en selecteert u de knop Extra om de beschikbare hulpprogramma's weer te geven.

    Schermopname van de knop Hulpmiddelen in chat.

  2. Selecteer een of meer hulpprogramma's van de MCP-server die beschikbaar zijn in de chat.

    Schermopname van het selecteren van hulpprogramma's in Visual Studio Code.

  3. Voer een prompt in de chat in om het hulpprogramma aan te roepen. Als u bijvoorbeeld een hulpprogramma hebt geselecteerd om informatie over een bestelling op te halen, kunt u de agent vragen om een order.

    Get information for order 2

    Selecteer Doorgaan om de resultaten weer te geven. De agent gebruikt het hulpprogramma om de MCP-server aan te roepen en retourneert de resultaten in de chat.

    Schermopname van chatresultaten in Visual Studio Code.

Probleemoplossing en veelvoorkomende problemen

Probleem Oorzaak Solution
401 Unauthorized fout van back-end Autorisatieheader niet doorgestuurd Beleid gebruiken set-header om het token handmatig te koppelen
API-aanroep werkt in API Management, maar mislukt in agent Onjuiste basis-URL of ontbrekend token Beveiligingsbeleid en eindpunt controleren
STREAMING van MCP-server mislukt wanneer diagnostische logboeken zijn ingeschakeld Logboekregistratie van antwoordtekst of toegang tot antwoordbody via beleid interfereert met MCP-transport Logboekregistratie van antwoordtekst uitschakelen in het bereik Alle API's - zie Vereisten

Verwante inhoud