@cognigy/plugin-engine

中文文档
1.22.6发布于 2026/11/07MITTypeScriptES Module构建来源已验证近 30 天下载 2996

NICE 认知插件( Claude Code, Codex等) 的 MCP 服务器引擎

中文使用文档
文档目录24 节
  1. 特征
  2. 安装
  3. 第1步——运行安装器
  4. 步骤2——检查客户行
  5. 不断更新
  6. 配置
  7. 审计归属
  8. 公司代理人
  9. 自行托管和地方集群
  10. 用法实例
  11. 1. 设立客户支助代理
  12. 2. 测试和改进制剂
  13. 3. 为RAG添加一个知识库
  14. 4. 列出所有项目和代理人
  15. 5. 向项目导入包件
  16. 6. 从项目资源中导出一揽子
  17. 7. 配置语音预览并创建一个浏览器语音端点
  18. 8. 配置用于搜索的知识AI设置
  19. 工具
  20. 警卫
  21. 隐私政策
  22. 支助
  23. 文档
  24. 许可证

NICE 认知插件

完全通过每个客户端的本地插件机制分配—— a 插件 打开 克劳德代码, (中文(简体) ), 克劳德桌面, (中文(简体) ), ChatGPT + 编码器,以及 反重力页:1 插件 打开 光标,则 代理插件- 任何兼容主机上的标准插件(基罗, (中文(简体) ), VS 代码 + 副驾驶,. )——会有更多客户前来. 每个软件包安装服务器引擎和船舶技能+代理.

连接您的 AI 助手到 识相. 大赦国际 爱普。 通过自改进循环——不离开客户端,创建,测试并改进基于LLM的AI Agents.

快速链接 : 安装 • 妇女 不断更新

特征

  • 18个工作流程工具 用于代理创建、部署、包装、备份、语音设置和代理对代理(A2A)代表团
  • 设置一通电话代理: 创建代理 + 流程 + AI代理 任务节点 + REST 自动结束点
  • 自改进循环: 与你的经纪人交谈,评价答复,更新职务说明,重复
  • 知识储存支助: 将RAG 知识库作为工具加入代理
  • 浏览器语音部署: 创建带有 WebRTC 演示 URL 的语音网关端点
  • 语音预览设置: 为语音体验配置支持的语音提供者
  • 技能+代理人:工作流程指导自动加载作为支持客户端的技能;构建/go-live 循环作为子代理运行
  • 内置文件查询: 捆绑官员 认知文件 MCP 服务器 — 您的助手在回答平台问题之前搜索并读取文档, 而不是从培训数据中猜测
  • 内建速率限制,Zod输入验证,RFC 7807出错响应

安装

两步. 第1步对每个客户都是一样的. 第二步就是检查你的委托人仍然需要你的东西——对于大多数的委托人来说,这没什么,但答案在表格中,所以要检查你的委托人而不是假设.

第1步——运行安装器

一个安装器覆盖每个客户端. 运行它, 选择您的客户端, 输入您的 Cognigy API 基础 URL( 输入试运行默认值) 和 API 密钥( 按您键键), 然后重新启动客户端 .

macOS / Linux 系统 ——一行(检查Node.js,然后运行安装器):

bash <(curl -fsSL https://raw.githubusercontent.com/Cognigy/cognigy-plugin/main/install.sh)

视窗( PowerShell) - 打开为 署长,则:

irm https://raw.githubusercontent.com/Cognigy/cognigy-plugin/main/install.ps1 | iex

靴子陷阱只检查Node.js 20+的存在(它告诉你如果不安装它——它永远不会为您安装它),然后准确运行下面的命令. 随你喜欢使用,他们也这样做.

已经 节点.js 20+跳过靴子:

npx -y -p @cognigy/plugin-engine@latest cognigy-setup

步骤2——检查客户行

安装者会给您在任何地方的证书打电线,并在任何可能的地方安装插件,但有些客户端需要您手动一步. 在下面找到你的客户 然后做什么 安装器后的额外步骤 说.. 无 表示第1步完成了任务. 每个指南都有完整的指令,Windows注释,如何验证它的工作,以及排除出故障.

光标是一个完全不需要安装器的客户端:它自己收集您的证书,这样您就可以从它的向导开始跳过步骤一.

客户端工具技能探员安装器后的额外步骤自动更新
克劳德代码 (CLI + 桌面"代码"标签)✅✅✅无启用一次 1个
克劳德桌面聊天✅✅✅安装应用中的插件自动
ChatGPT + 编码器 (CLI + IDE) (中文(简体) )✅✅—— 说无自动
反重力 (内审司+) agy CLI) (中文(简体) )✅✅✅无自动
光标✅✅✅安装 + 设置两个变量 2个由光标管理
其他主机 (VS代码,克洛,✅✅✅在主机本身安装插件手动 3个

1个 Claude Code为第三方市场提供自动更新服务 /plugin → Marketplaces → cognigy-plugin。 。 。 . 2个 Cursor要求证书本身(Plugins → Capital),所以不需要安装器——参见它的向导. 3个 主机拥有插件版本.

脚本/ CI

跳过带有旗帜的提示 :

npx -y -p @cognigy/plugin-engine@latest cognigy-setup \
  --client claude-code --client claude-desktop --client codex \
  --client antigravity --client other-hosts \
  --api-base-url https://api-trial.cognigy.ai --api-key <key>

--client 可重复; 有效值为 claude-code, (中文(简体) ), claude-desktop, (中文(简体) ), codex, (中文(简体) ), antigravity,以及 other-hosts。以交互模式打开它从菜单中选择.

不断更新

见 自动更新 在上表中的栏中,列出每个客户端自行做的事情。 而不是等待客户注意到:

npx -y -p @cognigy/plugin-engine@latest cognigy-setup update

安装者作为管理器双倍:

npx -y -p @cognigy/plugin-engine@latest cognigy-setup status      # what's installed, per client, + latest available
npx -y -p @cognigy/plugin-engine@latest cognigy-setup update      # pull the latest where it isn't automatic
npx -y -p @cognigy/plugin-engine@latest cognigy-setup uninstall   # remove from every client (--client narrows it; --purge also clears ~/.cognigy-plugin)

在MCP工具之外,插件船 技能 财务报告和审定财务报表 代理人 自动显示工作流程:

  • 技能 (单位:千美元)/skills)——每个工作流程一个(代理创建,知识/RAG,语音网关,语音上线核对表,网络聊天,流节点,软件包,设置,LLM提供者,工具,红色团队,故障排除等). Claude 自动装入匹配的技巧, 当您的请求适合时。 红队在您的主要会话中运行——而不是作为副代理——这样它就可以约定范围合同,在应用修正之前获得批准,并为您打开完成报告.
  • 探员 (单位:千美元)/agents(b) —— cognigy-agent-builder 运行新代理的完整构建和测试循环 cognigy-voice-go-live 对Go-Live核对表的语音代理进行审计,并应用安全修复。 每一个都按自己的背景进行,并报告一个摘要.

配置

这个 安装器 收集你的 认知 API 基础 URL 财务报告和审定财务报表 API 密钥 给每个客户端电线:根据克洛德密码输入系统 键盘链在 Claude 桌面上输入 claude_desktop_config.json (单位:千美元)chmod 600) (中文(简体) ). 引擎作为环境变量接收它们. 如果某一次发射都丢失了,引擎会回到 ~/.cognigy-plugin/config.json (单位:千美元)chmod 600)),安装者也写着——所以从环境出发的证书决心,然后是那个文件. ChatGPT + Codex, Antigravity, 和其他主机完全依赖于该文件:他们的客户端配置没有秘密.

一个未扩展的值 ${...} 占位符计算为缺失。 Claude代码以外的主机不执行 userConfig 并传递清单 ${user_config.cognigy_api_key} 从字面上; 将它视为真正的证明, 既会失败请求, 也会阴影文件的倒置。 下面的可选变量可以设置在 MCP 服务器中 env 如果您需要覆盖默认值.

变量需求默认说明
COGNIGY_API_BASE_URL对—— 说您的认知 API 基础 URL
COGNIGY_API_KEY对—— 说您的认知 API 密钥
LOG_LEVEL没有infodebug, (中文(简体) ), info, (中文(简体) ), warn, (中文(简体) ), error
RATE_LIMIT_MAX_REQUESTS没有100每个窗口的最大请求
RATE_LIMIT_WINDOW_MS没有60000速率限制窗口( ms)
COGNIGY_DISABLE_AUDIT_ATTRIBUTION没有未设定设定为 1 停止在 Cognigy 审计活动中命名插件
HTTPS_PROXY 编号 : HTTP_PROXY没有未设定公司代理通过隧道认知请求
NO_PROXY没有未设定绕过代理服务器直接到达逗号分隔主机
NODE_EXTRA_CA_CERTS没有未设定用于 TLS 代理检查的企业根 CA 路径
COGNIGY_PROXY_CONNECT_TIMEOUT_MS没有30000到达代理和完成隧道的最后期限
COGNIGY_ENDPOINT_BASE_URL没有来源端点主机, 当无法从 API 主机获取时
COGNIGY_WEBCHAT_BASE_URL没有来源Webchat 主机, 当无法从 API 主机中获取时
COGNIGY_STATIC_FILES_BASE_URL没有来源静态文件主机, 当无法从 API 主机中获取时

审计归属

此插件更改记录在 行政中心 审计活动 与 performedBy.actor = "mcp-plugin",所以插件制造的更改可以区别于手动更改的人(手动更改不包含 performedBy) (中文(简体) ). 每个 MCP 工具呼叫都有它自己的 taskId 和每个引擎运行自己的 sessionId,所以一个工具调用组的写作在一起.

需要Cognigy.AI 2026.17.0或更新;更古老的版本忽略了归属,正常记录动作. 在UI的"由"一栏 门在平台后面 FEATURE_ENABLE_PLATFORM_AGENT_MFE 标记,但归属总是被记录 并且总是可以通过 list_resources { resourceType: "audit_event", actor: ["mcp-plugin"] }。 。 。 .

设定 COGNIGY_DISABLE_AUDIT_ATTRIBUTION=1 以选择退出;然后将插件动作记录为 API 动作.

公司代理人

如果您的网络需要代理, 请设置在 MCP 服务器中 env 块(或在启动客户端前导出它)和插件隧道

"env": {
  "HTTPS_PROXY": "http://proxy.corp.example:8080",
  "NO_PROXY": "localhost,127.0.0.1",
  "NODE_EXTRA_CA_CERTS": "/etc/ssl/certs/corporate-root-ca.pem"
}

小写拼写(https_proxy与URL中的证书一样工作(http://user:[email protected]:8080. HTTP 和 HTTPS 代理支持; SOCKS 代理不支持.

代理是按请求选择的,所以 NO_PROXY 可以排除一个主机,而另一个主机仍然通过代理机——一个包下载链接,例如,在平台设置存档的任何地方的点数,而不是API主机.

如果一个代理被配置但无法使用——一个错误的URL,或者一个 SOCKS 代理——请求 配置错误失败 而不是悄悄地直接连接, 它会把你的 API 密钥发送到批准路径之外。 排除主机为 NO_PROXY 如果你真的想要一个直接的连接.

一个接受连接,然后永远不完成隧道的代理,否则会无限期地挂起一个工具呼叫,因此连接和谈判被限制在30秒. 提升 COGNIGY_PROXY_CONNECT_TIMEOUT_MS 如果您的代理仅仅是缓慢.

如果您的代理检查 TLS (Zscaleer,Netskope,BlueCoat等),它提出自己由公司根CA签名的证书,而节点默认不信任. 点 NODE_EXTRA_CA_CERTS 在 CA 文件上——节点只在启动时读取,所以之后重新启动客户端. 从来没有设置 NODE_TLS_REJECT_UNAUTHORIZED=0 代替; 这样会禁用对引擎每次连接的证书验证 .

为确认引擎提取了设置, 设置 LOG_LEVEL=debug 寻找 Cognigy API requests route through a proxy 在您的客户端的 MCP 日志。 GUI客户端(Claude Desktop, Antigravity)启动引擎时环境最小,往往不会继承您 shell 的代理变量,因此将其设置在配置文件中而不是您 shell 配置中.

自行托管和地方集群

引擎对不止一个认知主机进行交谈: API for everything, 端点主机为 talk_to_agent,用于嵌入片段的网络聊天和静态主机。 其他三个来源于 COGNIGY_API_BASE_URL 通过互换 api 段次 - api-dev.cognigy.ai 给 endpoint-dev.cognigy.ai, (中文(简体) ), cognigy-api-na1.nicecxone.com 给 cognigy-endpoint-na1.nicecxone.com,而本地集群的 api.test 给 endpoint.test。如果您的主机名称没有遵循此模式,则设置 COGNIGY_ENDPOINT_BASE_URL, (中文(简体) ), COGNIGY_WEBCHAT_BASE_URL 财务报告和审定财务报表 COGNIGY_STATIC_FILES_BASE_URL 明确;引擎启动时警告(Could not derive the endpoint host当它不得不倒回API主机时.

为自签名证书服务的集群被拒绝 DEPTH_ZERO_SELF_SIGNED_CERT,因为节点不咨询操作系统信任商店。 点 NODE_EXTRA_CA_CERTS 在证书(或签发证书的本地 CA)中,与上面的TLS-检查代理完全相同.

用法实例

1. 设立客户支助代理

Create a Cognigy AI Agent called "Support Bot" in project <projectId> with a helpful
customer support persona. If the project has no working LLM, first look for another
project with an llm_model that has a connectionId, import that LLM and its connection
via manage_packages, and only fall back to setup_llm if no reusable LLM exists.
Return the endpoint URL only after the project has a confirmed working LLM.

MCP服务器应先检查目标项目是否已经具有工作LLM. 如果不是,它更倾向于重新使用所需的LLM资源集,加上它从另一个项目产生的连接资源 manage_packages,仅使用 setup_llm 作为打电话前的最后手段 create_ai_agent。 。 。 .

2. 测试和改进制剂

Talk to my Support Bot at <endpointUrl> and ask "How do I reset my password?".
Then update the job description to make the response more concise and actionable.
Talk to it again and compare the responses.

这触发了自改进循环: talk_to_agent 评估 update_ai_agent → talk_to_agent 再来一次.

3. 为RAG添加一个知识库

Create a knowledge store in project <projectId>, add the URL
https://docs.example.com/faq as a source, then attach it to my Support Bot
so the agent can search it when answering questions.

服务器会呼叫 manage_knowledge 创建商店并吞入 URL, 接下来 create_tool 把它作为代理工作的知识搜索工具 节点.

如果项目将使用知识搜索, 服务器应首先配置 知识AI 设置 manage_settings { operation: 'set_knowledge_ai', ... } 使用同一工程的模型标识.

对于正常的AI代理知识流来说,应该在 manage_knowledge { operation: 'create_store', ... }。 。 。 .

模式角色不同:

  • 知识库本身需要一个能嵌入的指数模型.
  • knowledgeSearchModelId 是一个单独的用于搜索的知识 AI 设置 行为,但被接受的模型类型是依实例而定的.
  • 如果重用另一个项目的知识设置,请确定确切的源项目 Knowledge 搜索模式, 并先导入到目标项目中 第一个 set_knowledge_ai 尝试.
  • 导入一个通行证中的全部所需知识模式。 如果嵌入 模式,知识搜索模式,代理模式共享一个连接,传输 和所有这些模型一起的单一连接.
  • 在将 LLMS 导入目标项目后, 列出目标 项目的 llm_model 资源,并先尝试那些相同的项目ID 创建新模式.
  • 具体用于知识搜索, 使用 list_resources 与 resourceType: 'llm_model' 财务报告和审定财务报表 useCase: 'knowledgeSearch' 这么说 候选人匹配设置 UI 下放而非未过滤 全项目LLM列表.
  • 不替换新式或通用型号 knowledgeSearchModelId 除非用户明确要求该候选人和现有的同一项目候选人 已经失败 API 验证 .
  • 如果目标缺少精确的源项目知识搜索模式 工程,在尝试不同的模型之前导入它.
  • 如果所有同一项目候选人都失败,请报告准确的尝试型号ID 和 API 错误,而不是声称平台边错误 .
  • 不要将未试模型描述为"可能"不支持或拒绝.
  • 将实例中的模型名称仅作为实例,而不是作为真理的来源.

4. 列出所有项目和代理人

List all my Cognigy projects and show which AI Agents exist in each one.

用途 list_resources 与 resourceType: 'project' 财务报告和审定财务报表 resourceType: 'agent'。 。 。 .

5. 向项目导入包件

Upload the package at /absolute/path/to/support-bot.zip into project <projectId>,
show me the import preview, then import it using the default selections.

用途 manage_packages 与 operation: 'upload_and_inspect',则 operation: 'import'。 。 。 .

6. 从项目资源中导出一揽子

Create a package named "support-bot" from these resource IDs in project <projectId>,
include dependencies, and save the zip to /absolute/path/to/exports/.

用途 manage_packages 与 operation: 'list_exportable' 然后发现候选人 operation: 'export',则 operation: 'download' 需要的时候.

7. 配置语音预览并创建一个浏览器语音端点

Set the voice preview provider for project <projectId> to Microsoft, then create
a Voice Gateway endpoint for flow <flowId> named "Support Voice" and give me the
WebRTC demo URL I can open in the browser.

这个用 manage_settings 与 operation: 'set_voice_preview' 配置语音,然后 manage_voice_gateway 规定a voiceGateway2 结尾为 a webrtcDemoUrl。 。 。 .

Configure Knowledge AI settings for project <projectId> by setting the Knowledge Search
model and the Content Parser. If I am creating a new project and another project already
has a working knowledge setup, reproduce that exact Knowledge Search model and Content
Parser choice in the new project before trying generic defaults.

这个用 manage_settings 与 operation: 'set_knowledge_ai' 要配置 knowledgeSearch 财务报告和审定财务报表 contentParser 在项目设定一级。 重用 设置并不意味着仅复制另一个工程的设置; 需要 模型必须首先存在于目标项目中,要么通过导入,要么在那里创建. 对于知识工作流程,MCP应导入所需的全套源项目模型集 在一个通道中,重复使用共享连接仅一次,并尝试导入的同项目模式 回归前的身份证 setup_llm。 。 。 .

工具

工具类型说明
create_ai_agent写入创建完整的 AI 代理, 自动提供流程、 工作节点和 REST 端点
update_ai_agent写入更新人物a、护栏、工作配置(作用、程序、LLM、温度)
setup_llm写入创建 LLM 资源( GPT-4, Claude, Mistral等), 并自动进行连接验证
talk_to_agent写入向AI代理发送消息并获得其响应( 使用 Endpoint Test Mode, 因此不计为可计费)
list_resources读取列出项目、代理、流动、终点、法学硕士、知识库等
get_resource读取获取关于单一资源的详细信息
delete_resource写入永久删除资源
manage_knowledge写入创建知识存储、 添加源( URL、 文本、 文件) 、 列表块用于 RAG
create_tool写入在代理任务节点中添加一个工具( HTTP, 知识, 电子邮件, MCP, A2A)
update_tool写入更新已有工具节点的配置
manage_webchat写入为网站部署创建或配置 Webchat v3 端点
manage_flow_nodes写入创建、更新、删除或列出对话逻辑的流节点
manage_packages写入列出可导资源、上传、检查、导入、导出和下载 Cognigy 包zip 文件
manage_voice_gateway写入为基于浏览器的语音互动创建或配置带有 WebRTC 的语音网关端点
manage_a2a_server写入作为 A2A (代理) 服务器端点部署一个流程, 其他代理可以发现和调用
manage_settings写入管理项目级别设置,包括语音预览和知识AI配置
audit_voice_agent写入对Go-Live核对表进行语音代理审计;默认报告,按要求适用安全补偿
manage_snapshots写入创建并恢复工程快照, 这样代理更改可以回滚

详细的工作流程指导(代理创建、知识/RAG、语音、网络聊天、A2A、流程节点、软件包、设置、LLM供应商、工具、故障排除) 技能 当您的请求匹配时, 在支持它们的客户端中自动加载( 如 Claude Code) —— 见 技能 在客户端表格中的列 安装。这些工具是用来使用这些技能的:如果助手跳过步骤或得到一个认知工作流程错误,则检查这些技能是否被加载(Claude Code, /skills 列出它们),如果缺少,则重新安装插件.

警卫

  • API 密钥通过环境变量传递,从未登录
  • 所有输入在到达 API 之前使用 Zod schemas 验证
  • 为防止滥用API, 规定了限制费率

隐私政策

这个 MCP 服务器向 Cognigy 发送请求 。 AI API 端点通过配置 COGNIGY_API_BASE_URL。这个 MCP 服务器本身没有收集、存储或共享数据——所有数据都保留在你的AI客户端和你的认知之间。 AI实例.

全面隐私政策: https://www.cognigy.com/privacy-policy 互联网档案馆的存檔,存档日期2013-12-22

支助

文档

许可证

麻省理工学院

版本与发布记录

@cognigy/plugin-engine 共发布 39 个版本,首次发布于 2026/06/25;过去 12 个月发布了 39 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.22.6latest2026/11/073 天前
1.22.52026/10/3010 天前
1.22.42026/10/2813 天前
1.22.32026/10/2318 天前
1.22.22026/10/1921 天前
1.22.12026/10/1328 天前

关于 @cognigy/plugin-engine 的常见问题

@cognigy/plugin-engine 是什么?

NICE 认知插件( Claude Code, Codex等) 的 MCP 服务器引擎

如何安装 @cognigy/plugin-engine?

在项目目录运行 npm install @cognigy/plugin-engine,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 cognigy-mcp、cognigy-setup,可以用 npx cognigy-mcp 直接运行。

@cognigy/plugin-engine 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@cognigy/plugin-engine 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@cognigy/plugin-engine 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@cognigy/plugin-engine 可以商用吗?

@cognigy/plugin-engine 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@cognigy/plugin-engine 的下载量有多少?

根据 npm 官方下载统计,@cognigy/plugin-engine 在 2026/10/11 – 2026/11/09 这 30 天内被下载 2,996 次,日均约 100 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@cognigy/plugin-engine 还在维护吗?

最新版本 1.22.6 发布于 2026/11/07(3 天前);至今共发布 39 个版本,其中过去 12 个月发布了 39 个;首次发布于 2026/06/25。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。