跳至正文
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 插件,可在桌面应用中通过 安装到此电脑 进行安装。安装后,请直接输入认证令牌和环境变量。

本页目录