Apisix MCP

🚀 APISIX 模型上下文協議（MCP）服務器

APISIX 模型上下文協議（MCP）服務器用於連接大型語言模型（LLMs）與 APISIX 管理 API，其核心價值在於藉助 MCP 兼容的 AI 客戶端，實現對 APISIX 資源查看和管理的自然語言交互，極大提升了操作的便捷性。

點擊查看相關視頻

🚀 快速開始

✨ 支持的操作

常見操作

• get_resource：按類型（路由、服務、上游等）獲取資源。
• delete_resource：通過 ID 刪除資源。
• send_request_to_gateway：向 APISIX 網關發送請求或多個請求。

API 資源操作

• create_route/update_route/delete_route：管理路由。
• create_service/update_service/delete_service：管理服務。
• create_upstream/update_upstream/delete_upstream：管理上游。
• create_ssl/update_ssl/delete_ssl：管理 SSL 證書。
• create_or_update_proto：管理 protobuf 定義。
• create_or_update_stream_route：管理流路由。

插件操作

• get_all_plugin_names：獲取所有可用插件名稱。
• get_plugin_info/get_plugins_by_type/get_plugin_schema：檢索插件配置。
• create_plugin_config/update_plugin_config：管理插件配置。
• create_global_rule/update_global_rule：管理插件全局規則。
• get_plugin_metadata/create_or_update_plugin_metadata/delete_plugin_metadata：管理插件元數據。

安全配置

• get_secret_by_id/create_secret/update_secret：通過 ID 獲取密鑰、創建或更新密鑰。
• delete_secret：刪除密鑰。
• encrypt_data/decrypt_data：加密和解密數據。
• sign_data/verify_signature：簽名數據和驗證簽名。

📦 安裝指南

在 AI 客戶端中的配置說明

使用現有的 MCP 服務器實例

要開始使用，請確保已運行 APISIX 和 MCP 服務器，並且已安裝並啟用了 OpenAI 插件。

配置 MCP 服務器以與 APISIX 管理 API 進行交互

1. 步驟一：在 APISIX 中啟用 MCP 支持 在 apisix/conf.lua 中添加以下內容：

core.log("Initializing APISIX MCP support")

2. 步驟二：配置 MCP 服務器以連接到 APISIX 管理 API 修改 MCP 服務器的配置文件（如 config.js），並設置環境變量或在配置中指定：

{
  "apisix": {
    "host": process.env.APISIX_HOST || "http://localhost:9080",
    "admin_key": process.env.APISIX_ADMIN_KEY || "edd1c9f034335f136f87ad84b625c8f1"
  }
}

🔧 技術細節

環境變量

以下是 MCP 服務器所需的環境變量及其默認值：

如需修改 APISIX 的管理 API 配置，請參考 APISIX 管理 API 文檔。