跳到內容
KeuralDocs
開發人員

外掛程式與 MCP 伺服器串接

如何將你自己的 MCP 伺服器連接到 Keural,並為桌面應用程式製作外掛程式套件。

Keural 的外掛程式是 MCP(Model Context Protocol)伺服器。本文件說明如何將自有的 MCP 伺服器連接到 Keural,或製作桌面應用程式用的外掛程式套件。

傳輸方式

平台傳輸方式用途
網頁與行動版HTTP(Streamable HTTP)· SSE可從網際網路連線的遠端 MCP 伺服器
桌面應用程式STDIO · HTTP在此電腦執行的伺服器,內部網路的 HTTP 伺服器
  • 網頁對話中只能使用遠端 HTTP 與 SSE 伺服器。STDIO 伺服器會在桌面應用程式中執行。
  • 伺服器位址以 /mcp 結尾時,大多是 Streamable HTTP 伺服器,因此請將傳輸方式選為 HTTP。
  • 桌面應用程式中的 HTTP 用於內部網路位址。公開網際網路位址請在網頁上以 HTTP 登錄。

直接新增的輸入值

設定 → 外掛程式 → + 新增自訂 MCP 的輸入欄位如下。

欄位內容
名稱必填
說明選填
傳輸方式參見上表
分類清單中的分類
伺服器 URLHTTP 或 SSE 時必填。例如:https://example.com/mcp
執行指令STDIO 時必填。例如:npx
引數STDIO 引數(JSON 陣列)。例如:["-y", "@scope/server"]
網頁搜尋時使用此外掛程式開啟後,網頁搜尋會改用此外掛程式。
驗證無 · API 金鑰
標頭名稱 · API 金鑰值選擇 API 金鑰時填寫。例如:標頭名稱 Authorization,值 Bearer …

選擇 API 金鑰後,每個請求都會附加 <標頭名稱>: <值> 標頭。

OAuth 驗證伺服器

組織管理人員以 OAuth 方式登錄的外掛程式,使用者按下 連線 並登入即可使用。

項目值
伺服器探索/.well-known/oauth-protected-resource(含路徑 → 根目錄),然後是 /.well-known/oauth-authorization-server
用戶端登錄動態用戶端登錄(DCR)
重新導向 URIhttps://api.keural.ai/api/user-connectors/oauth/callback
請求標頭Authorization: Bearer <存取權杖>

登入視窗會以彈出視窗開啟,登入完成後會更新外掛程式清單。

工具權限

設定每個外掛程式工具的執行方式。

權限行為
一律允許不詢問直接執行。
每次詢問執行前顯示核准卡片,卡片上也會顯示工具引數。
封鎖代理程式不使用此工具。

桌面外掛程式套件

桌面應用程式以 外掛 ZIP 檔案… 或 外掛資料夾… 安裝外掛程式。套件中需要包含資訊清單 plugin.json。

{
  "id": "my-plugin",
  "name": "My Plugin",
  "version": "1.0.0",
  "description": "查詢內部系統",
  "mcpServers": {
    "my-server": {
      "command": "node",
      "args": ["server.js"],
      "env": { "API_BASE": "https://intranet.example.com" }
    }
  }
}
欄位必填內容
id是英文小寫字母、數字與連字號
name否顯示名稱。若沒有,則使用 id。
version否預設 1.0.0
description否說明
minAppVersion否所需的最低應用程式版本
mcpServers否MCP 伺服器定義。每個伺服器包含 command、args、env。
requests否要求的權限(capabilities、commands、connectors、secrets、permissions)。字串陣列

在網頁上登錄的 STDIO 外掛程式,在桌面應用程式中按 安裝到此電腦 即可安裝。安裝後,請自行輸入驗證權杖與環境變數。

本頁內容