apimsample.md

กรณีศึกษา: การเปิดเผย REST API ใน API Management เป็น MCP server

Azure API Management เป็นบริการที่ให้ Gateway อยู่บน API Endpoints ของคุณ วิธีการทำงานคือ Azure API Management ทำหน้าที่เหมือนพร็อกซีอยู่หน้าของ API ของคุณ และสามารถตัดสินใจว่าจะจัดการกับคำขอที่เข้ามาอย่างไร

เมื่อใช้บริการนี้ คุณจะได้ฟีเจอร์มากมาย เช่น:

• ความปลอดภัย คุณสามารถใช้ได้ตั้งแต่ API keys, JWT ไปจนถึง managed identity
• การจำกัดอัตราการเรียกใช้งาน ฟีเจอร์ที่ยอดเยี่ยมคือการกำหนดจำนวนการเรียกใช้งานที่อนุญาตในช่วงเวลาหนึ่ง ซึ่งช่วยให้ผู้ใช้ทุกคนได้รับประสบการณ์ที่ดีและป้องกันไม่ให้บริการของคุณถูกคำขอมากเกินไป
• การปรับขนาดและการกระจายโหลด คุณสามารถตั้งค่า endpoints หลายตัวเพื่อกระจายโหลด และยังสามารถกำหนดวิธีการ "load balance" ได้
• ฟีเจอร์ AI เช่น semantic caching, การจำกัดโทเค็น และการตรวจสอบโทเค็น ฟีเจอร์เหล่านี้ช่วยเพิ่มความรวดเร็วในการตอบสนองและช่วยให้คุณควบคุมการใช้โทเค็นได้ดีขึ้น อ่านเพิ่มเติมที่นี่

ทำไมต้องใช้ MCP + Azure API Management?

Model Context Protocol กำลังกลายเป็นมาตรฐานสำหรับแอป AI ที่มีความสามารถเชิงตัวแทน (agentic) และวิธีการเปิดเผยเครื่องมือและข้อมูลอย่างสม่ำเสมอ Azure API Management เป็นตัวเลือกที่เหมาะสมเมื่อคุณต้องการ "จัดการ" APIs MCP Servers มักจะรวมกับ APIs อื่นๆ เพื่อแก้ไขคำขอไปยังเครื่องมือบางอย่าง ดังนั้นการรวม Azure API Management กับ MCP จึงเป็นแนวทางที่สมเหตุสมผลมาก

ภาพรวม

ในกรณีศึกษานี้ เราจะเรียนรู้วิธีเปิดเผย API endpoints เป็น MCP Server ด้วยวิธีนี้ เราสามารถทำให้ endpoints เหล่านี้เป็นส่วนหนึ่งของแอป agentic ได้อย่างง่ายดาย พร้อมกับใช้ประโยชน์จากฟีเจอร์ของ Azure API Management

ฟีเจอร์หลัก

• คุณเลือกวิธีการของ endpoint ที่ต้องการเปิดเผยเป็นเครื่องมือ
• ฟีเจอร์เพิ่มเติมที่คุณได้รับขึ้นอยู่กับการตั้งค่าในส่วน policy สำหรับ API ของคุณ แต่ในที่นี้เราจะแสดงวิธีเพิ่มการจำกัดอัตราการเรียกใช้งาน

ขั้นตอนเบื้องต้น: นำเข้า API

ถ้าคุณมี API ใน Azure API Management อยู่แล้ว ยอดเยี่ยม คุณสามารถข้ามขั้นตอนนี้ได้ หากยังไม่มี ลองดูที่ลิงก์นี้ การนำเข้า API ไปยัง Azure API Management

การเปิดเผย API เป็น MCP Server

เพื่อเปิดเผย API endpoints ให้ทำตามขั้นตอนดังนี้:

1. ไปที่ Azure Portal และที่อยู่ https://portal.azure.com/?Microsoft_Azure_ApiManagement=mcp
   ไปยังอินสแตนซ์ API Management ของคุณ

2. ในเมนูด้านซ้าย เลือก APIs > MCP Servers > + Create new MCP Server

3. ใน API ให้เลือก REST API ที่ต้องการเปิดเผยเป็น MCP server

4. เลือก API Operations หนึ่งหรือมากกว่าที่ต้องการเปิดเผยเป็นเครื่องมือ คุณสามารถเลือกทุก operation หรือเลือกเฉพาะบาง operation

   

5. เลือก Create

6. ไปที่เมนู APIs และ MCP Servers คุณจะเห็นดังนี้:

   

   MCP server ถูกสร้างขึ้นและ API operations ถูกเปิดเผยเป็นเครื่องมือ MCP server จะแสดงในแผง MCP Servers คอลัมน์ URL แสดง endpoint ของ MCP server ที่คุณสามารถเรียกใช้เพื่อทดสอบหรือใช้ในแอปพลิเคชันลูกค้า

ตัวเลือกเสริม: การตั้งค่า policies

Azure API Management มีแนวคิดหลักคือ policies ซึ่งเป็นกฎต่างๆ ที่คุณตั้งค่าสำหรับ endpoints เช่น การจำกัดอัตราการเรียกใช้งาน หรือ semantic caching กฎเหล่านี้เขียนในรูปแบบ XML

นี่คือวิธีตั้งค่า policy เพื่อจำกัดอัตราการเรียกใช้งาน MCP Server ของคุณ:

1. ในพอร์ทัล ภายใต้ APIs เลือก MCP Servers

2. เลือก MCP server ที่คุณสร้าง

3. ในเมนูด้านซ้าย ภายใต้ MCP เลือก Policies

4. ในตัวแก้ไข policy ให้เพิ่มหรือแก้ไข policy ที่ต้องการใช้กับเครื่องมือของ MCP server กฎจะถูกกำหนดในรูปแบบ XML เช่น คุณสามารถเพิ่ม policy เพื่อจำกัดการเรียกใช้งานเครื่องมือของ MCP server (ในตัวอย่างนี้ จำกัด 5 ครั้งต่อ 30 วินาทีต่อที่อยู่ IP ของลูกค้า) ตัวอย่าง XML ที่จะทำให้เกิดการจำกัดอัตราการเรียกใช้งาน:

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

   นี่คือตัวอย่างภาพของตัวแก้ไข policy:

   

ลองใช้งาน

มาทดสอบให้แน่ใจว่า MCP Server ของเราทำงานตามที่ตั้งใจไว้

สำหรับการนี้ เราจะใช้ Visual Studio Code และ GitHub Copilot ในโหมด Agent เราจะเพิ่ม MCP server ลงในไฟล์ mcp.json ด้วยวิธีนี้ Visual Studio Code จะทำหน้าที่เป็นไคลเอนต์ที่มีความสามารถเชิงตัวแทน และผู้ใช้ปลายทางจะสามารถพิมพ์คำสั่งและโต้ตอบกับเซิร์ฟเวอร์ได้

มาดูวิธีเพิ่ม MCP server ใน Visual Studio Code:

1. ใช้คำสั่ง MCP: Add Server จาก Command Palette

2. เมื่อถูกถาม ให้เลือกประเภทเซิร์ฟเวอร์: HTTP (HTTP หรือ Server Sent Events)

3. ใส่ URL ของ MCP server ใน API Management ตัวอย่าง: https://.azure-api.net/-mcp/sse (สำหรับ SSE endpoint) หรือ https://.azure-api.net/-mcp/mcp (สำหรับ MCP endpoint) สังเกตความแตกต่างของการส่งข้อมูลคือ /sse หรือ /mcp

4. ใส่ server ID ตามที่คุณต้องการ ค่านี้ไม่สำคัญมาก แต่ช่วยให้คุณจำได้ว่าอินสแตนซ์เซิร์ฟเวอร์นี้คืออะไร

5. เลือกว่าจะบันทึกการตั้งค่าไว้ใน workspace settings หรือ user settings

• Workspace settings - การตั้งค่าเซิร์ฟเวอร์จะถูกบันทึกในไฟล์ .vscode/mcp.json ซึ่งใช้ได้เฉพาะใน workspace ปัจจุบัน

  mcp.json

  "servers": {
      "APIM petstore" : {
          "type": "sse",
          "url": "url-to-mcp-server/sse"
      }
  }

  หรือถ้าเลือกใช้ streaming HTTP เป็นการส่งข้อมูล จะมีรูปแบบแตกต่างเล็กน้อย:

  "servers": {
      "APIM petstore" : {
          "type": "http",
          "url": "url-to-mcp-server/mcp"
      }
  }

• User settings - การตั้งค่าเซิร์ฟเวอร์จะถูกเพิ่มในไฟล์ settings.json ระดับ global และใช้ได้ในทุก workspace การตั้งค่าจะมีลักษณะคล้ายดังนี้:

  

1. คุณยังต้องเพิ่มการตั้งค่า header เพื่อให้แน่ใจว่าเซิร์ฟเวอร์ยืนยันตัวตนกับ Azure API Management ได้อย่างถูกต้อง โดยใช้ header ชื่อ Ocp-Apim-Subscription-Key

   • นี่คือวิธีเพิ่ม header ใน settings:

   ซึ่งจะทำให้มีการแสดง prompt ให้ใส่ค่า API key ซึ่งคุณสามารถหาได้ใน Azure Portal สำหรับอินสแตนซ์ Azure API Management ของคุณ

   • หากต้องการเพิ่มใน mcp.json แทน สามารถเพิ่มได้ดังนี้:

   "inputs": [
     {
       "type": "promptString",
       "id": "apim_key",
       "description": "API Key for Azure API Management",
       "password": true
     }
   ]
   "servers": {
       "APIM petstore" : {
           "type": "http",
           "url": "url-to-mcp-server/mcp",
           "headers": {
               "Ocp-Apim-Subscription-Key": "Bearer ${input:apim_key}"
           }
       }
   }

ใช้โหมด Agent

ตอนนี้เราตั้งค่าทั้งใน settings หรือใน .vscode/mcp.json เรียบร้อยแล้ว ลองใช้งานกัน

จะมีไอคอน Tools แบบนี้ ซึ่งจะแสดงเครื่องมือที่เปิดเผยจากเซิร์ฟเวอร์ของคุณ:

1. คลิกไอคอน tools แล้วคุณจะเห็นรายการเครื่องมือดังนี้:

   

2. พิมพ์คำสั่งในแชทเพื่อเรียกใช้เครื่องมือ เช่น ถ้าคุณเลือกเครื่องมือเพื่อดึงข้อมูลเกี่ยวกับคำสั่งซื้อ คุณสามารถถามเอเจนต์เกี่ยวกับคำสั่งซื้อได้ นี่คือตัวอย่างคำสั่ง:

   get information from order 2
   

   ตอนนี้คุณจะเห็นไอคอนเครื่องมือถามว่าต้องการเรียกใช้เครื่องมือหรือไม่ เลือกเพื่อดำเนินการต่อ คุณจะเห็นผลลัพธ์ดังนี้:

   

   สิ่งที่คุณเห็นขึ้นอยู่กับเครื่องมือที่คุณตั้งค่าไว้ แต่แนวคิดคือคุณจะได้รับการตอบกลับเป็นข้อความแบบนี้

เอกสารอ้างอิง

นี่คือแหล่งข้อมูลเพิ่มเติมที่คุณสามารถเรียนรู้ได้:

• บทแนะนำเกี่ยวกับ Azure API Management และ MCP

• ตัวอย่าง Python: การรักษาความปลอดภัย MCP servers ระยะไกลโดยใช้ Azure API Management (ทดลอง)

• ห้องปฏิบัติการการอนุญาต MCP client

• ใช้ส่วนขยาย Azure API Management สำหรับ VS Code ในการนำเข้าและจัดการ APIs

• ลงทะเบียนและค้นหา MCP servers ระยะไกลใน Azure API Center

• AI Gateway รีโพสที่ยอดเยี่ยมที่แสดงความสามารถ AI หลายอย่างกับ Azure API Management

• เวิร์กช็อป AI Gateway มีเวิร์กช็อปที่ใช้ Azure Portal ซึ่งเป็นวิธีที่ดีในการเริ่มต้นประเมินความสามารถ AI

ข้อจำกัดความรับผิดชอบ:
เอกสารนี้ได้รับการแปลโดยใช้บริการแปลภาษาอัตโนมัติ Co-op Translator แม้เราจะพยายามให้ความถูกต้องสูงสุด แต่โปรดทราบว่าการแปลอัตโนมัติอาจมีข้อผิดพลาดหรือความไม่ถูกต้อง เอกสารต้นฉบับในภาษาต้นทางถือเป็นแหล่งข้อมูลที่เชื่อถือได้ สำหรับข้อมูลที่สำคัญ ขอแนะนำให้ใช้บริการแปลโดยผู้เชี่ยวชาญมนุษย์ เราไม่รับผิดชอบต่อความเข้าใจผิดหรือการตีความผิดใด ๆ ที่เกิดจากการใช้การแปลนี้