Zveřejnění rozhraní REST API ve službě API Management jako serveru MCP

PLATÍ PRO: Vývojář | Základní | Základní v2 | Standardní | Standardní v2 | Premium | Premium v2

Ve službě API Management můžete vystavit rozhraní REST API spravované ve službě API Management jako vzdálený server MCP (Model Context Protocol) pomocí integrované brány AI. Zveřejnění jedné nebo více operací rozhraní API jako nástrojů, které klienti MCP můžou volat pomocí protokolu MCP.

Azure API Management také podporuje zabezpečenou integraci se stávajícími servery kompatibilními s MCP – servery nástrojů hostované mimo službu API Management. Další informace najdete v tématu Zveřejnění existujícího serveru MCP.

Další informace o:

• Podpora serveru MCP ve službě API Management
• Možnosti brány AI

Omezení

• API Management v současné době podporuje serverové nástroje MCP, ale nepodporuje prostředky MCP ani výzvy.
• Api Management v současné době nepodporuje možnosti serveru MCP v pracovních prostorech.

Požadavky

• Pokud ještě nemáte instanci služby API Management, proveďte následující rychlý start: Vytvořte instanci služby Azure API Management. Instance musí být v jedné z úrovní služby, které podporují servery MCP.

• Ujistěte se, že vaše instance spravuje rozhraní API kompatibilní s protokolem HTTP (jakékoli rozhraní API importované jako rozhraní REST API, včetně rozhraní API importovaných z prostředků Azure), které chcete zveřejnit jako server MCP. Pokud chcete importovat ukázkové rozhraní API, přečtěte si téma Import a publikování prvního rozhraní API.

  Poznámka:

  Jiné typy rozhraní API ve službě API Management, které nejsou kompatibilní s protokolem HTTP, se nedají vystavit jako servery MCP.

• Pokud povolíte protokolování diagnostiky prostřednictvím Application Insights nebo Azure Monitoru v globálním oboru (všechna rozhraní API) pro instanci služby API Management, nastavte počet bajtů datové části na nastavení protokolu pro front-endovou odpověď na hodnotu 0. Toto nastavení zabraňuje nezamýšleným protokolováním orgánů odpovědí napříč všemi rozhraními API a pomáhá zajistit správné fungování serverů MCP. Pokud chcete protokolovat datové části selektivně pro konkrétní rozhraní API, nakonfigurujte nastavení jednotlivě v oboru rozhraní API, což umožňuje cílenou kontrolu nad protokolováním odpovědí.

• K otestování serveru MCP můžete použít Visual Studio Code s přístupem k GitHub Copilotu nebo nástrojům, jako je MCP Inspector.

Vystavení API jako serveru MCP

Při zveřejnění spravovaného rozhraní REST API ve službě API Management jako serveru MCP postupujte takto:

1. Na webu Azure Portal přejděte do vaší instance služby API Management.
2. V nabídce vlevo v části Rozhraní API vyberte servery>MCP + Vytvořit server MCP.
3. Vyberte Zveřejnit rozhraní API jako server MCP.
4. Na serveru MCP back-endu:
   1. Vyberte spravované rozhraní API , které se má zveřejnit jako server MCP.
   2. Vyberte jednu nebo více operací rozhraní API , které chcete zveřejnit jako nástroje. Můžete vybrat všechny operace nebo jenom konkrétní operace.

      Poznámka:

      Operace zveřejněné jako nástroje můžete aktualizovat později v okně Nástroje serveru MCP.

5. Na novém serveru MCP:
   1. Zadejte název serveru MCP ve službě API Management.
   2. Volitelně můžete zadat popis serveru MCP.
6. Vyberte Vytvořit.

• Vytvoří se server MCP a operace rozhraní API se zveřejňují jako nástroje.
• Server MCP je uvedený v okně Servery MCP . Sloupec Adresa URL serveru zobrazuje koncový bod serveru MCP, který má volat pro testování nebo v rámci klientské aplikace.

Konfigurace zásad pro server MCP

Nakonfigurujte jednu nebo více zásad služby API Management, které vám pomůžou se správou serveru MCP. Zásady platí pro všechny operace rozhraní API vystavené jako nástroje na serveru MCP. Pomocí těchto zásad můžete řídit přístup, ověřování a další aspekty nástrojů.

Další informace o konfiguraci zásad:

• Zásady ve službě API Management
• Transformace a ochrana rozhraní API
• Nastavení a úprava zásad
• Zabezpečený přístup k serveru MCP

Upozornění

Nepřistupujte k textu odpovědi pomocí context.Response.Body proměnné v rámci zásad serveru MCP. Tím se aktivuje ukládání odpovědí do vyrovnávací paměti, což koliduje s chováním streamování vyžadovaným servery MCP a může způsobit jejich selhání.

Chcete-li nakonfigurovat zásady pro server MCP, postupujte takto:

1. Na webu Azure Portal přejděte do vaší instance služby API Management.

2. V nabídce vlevo v části Rozhraní API vyberte Servery MCP.

3. Ze seznamu vyberte server MCP.

4. V nabídce vlevo v části MCP vyberte Zásady.

5. V editoru zásad přidejte nebo upravte zásady, které chcete použít pro nástroje serveru MCP. Definujte zásady ve formátu XML.

   Můžete například přidat zásadu, která omezí volání na nástroje serveru MCP (v tomto příkladu jedno volání za 60 sekund na relaci MCP).

   <!-- Rate limit tool calls by Mcp-Session-Id header -->
   <set-variable name="body" value="@(context.Request.Body.As<string>(preserveContent: true))" />
   <choose>
       <when condition="@(
           Newtonsoft.Json.Linq.JObject.Parse((string)context.Variables["body"])["method"] != null 
           && Newtonsoft.Json.Linq.JObject.Parse((string)context.Variables["body"])["method"].ToString() == "tools/call"
       )">
       <rate-limit-by-key 
           calls="1" 
           renewal-period="60" 
           counter-key="@(
               context.Request.Headers.GetValueOrDefault("Mcp-Session-Id", "unknown")
           )" />
       </when>
   </choose>
   

   

Poznámka:

Služba API Management vyhodnocuje zásady nakonfigurované v globálním oboru (všechna rozhraní API), než vyhodnotí zásady v oboru serveru MCP.

Ověření a použití serveru MCP

Použijte kompatibilního agenta LLM (například GitHub Copilot, Sémantic Kernel nebo Copilot Studio) nebo testovacího klienta (například curl) pro volání koncového bodu MCP hostovaného službou API Management. Ujistěte se, že požadavek obsahuje odpovídající hlavičky nebo tokeny, a ověřte úspěšné směrování a odpověď ze serveru MCP.

Návod

Pokud k otestování serveru MCP spravovaného službou API Management použijete kontrolu MCP , použijte verzi 0.9.0.

Přidání serveru MCP v editoru Visual Studio Code

V editoru Visual Studio Code pomocí chatu GitHub Copilot v režimu agenta přidejte server MCP a použijte nástroje. Základní informace o serverech MCP v editoru Visual Studio Code najdete v tématu Použití serverů MCP ve VS Code.

Přidání serveru MCP v editoru Visual Studio Code:

1. Použijte příkaz MCP: Přidání serveru z palety příkazů.

2. Po zobrazení výzvy vyberte typ serveru: HTTP (HTTP nebo Server Sent Events).

3. Zadejte adresu URL serveru MCP ve službě API Management. Například https://<apim-service-name>.azure-api.net/<api-name>-mcp/mcp pro koncový bod MCP.

4. Zadejte ID serveru podle vašeho výběru.

5. Vyberte, jestli chcete konfiguraci uložit do nastavení pracovního prostoru nebo do uživatelského nastavení.

   • Nastavení pracovního prostoru – Konfigurace serveru se uloží do .vscode/mcp.json souboru, který je k dispozici pouze v aktuálním pracovním prostoru.

   • Uživatelská nastavení – Konfigurace serveru se přidá do globálního settings.json souboru a je k dispozici ve všech pracovních prostorech. Konfigurace vypadá nějak takto:

   

Přidejte pole do konfigurace JSON pro nastavení, jako je hlavička ověřování. Následující příklad ukazuje konfiguraci klíče předplatného služby API Management předaného v hlavičce jako ve vstupní hodnotě. Další informace o formátu konfigurace

Použití nástrojů v režimu agenta

Po přidání serveru MCP v editoru Visual Studio Code můžete použít nástroje v režimu agenta.

1. V chatu GitHub Copilot vyberte režim agenta a výběrem tlačítka Nástroje zobrazte dostupné nástroje.

   

2. Vyberte jeden nebo více nástrojů ze serveru MCP, které chcete mít k dispozici v chatu.

   

3. Zadejte do chatu výzvu k vyvolání nástroje. Pokud jste například vybrali nástroj pro získání informací o objednávce, můžete požádat agenta o objednávce.

   Get information for order 2
   

   Výběrem možnosti Pokračovat zobrazíte výsledky. Agent používá nástroj k volání serveru MCP a vrací výsledky v chatu.

   

Řešení problémů a známé problémy

Problém	Příčina	Řešení
401 Unauthorized chyba z back-endu	Autorizační hlavička se nepřesměruje	V případě potřeby použijte set-header zásadu k ručnímu připojení tokenu.
Volání rozhraní API funguje ve službě API Management, ale v agentu selže	Nesprávná základní adresa URL nebo chybějící token	Pečlivě zkontrolujte zásady zabezpečení a koncový bod.
Streamování serveru MCP selže, když jsou povolené diagnostické protokoly	Protokolování těla odpovědi nebo přístupu k textu odpovědi prostřednictvím zásad koliduje s přenosem MCP	Zakázání protokolování textu odpovědi v oboru Všechna rozhraní API – viz Požadavky

Související obsah

• Ukázka: Autorizace serverů MCP pomocí chráněných metadat prostředků (PRM)

• Ukázka: Zabezpečení vzdálených serverů MCP pomocí služby Azure API Management (experimentální)

• Testovací prostředí pro autorizaci klienta MCP

• Použití rozšíření Azure API Management pro VS Code k importu a správě rozhraní API

• Registrace a zjišťování vzdálených serverů MCP ve službě Azure API Center

• Zveřejnění rozhraní REST API ve službě API Management jako serveru MCP

• Zveřejnění a řízení stávajícího serveru MCP