使用 Kanzi AI 工具¶
Kanzi 提供多种 AI 工具,帮助您查找信息、理解 Kanzi 的概念和 API,并更快地解决遇到的问题:
Ask Kanzi 是内置于 https://docs.kanzi.com 上 Documentation 中的 AI 助手,无需任何额外设置,只需点击任意文档页面右上角的 Ask Kanzi 按钮即可打开。
MCP 服务器 将您自己的 AI 编码代理(例如 Claude Code、VS Code、Cursor 等)连接到相同的底层 Documentation 和 API 参考,以及您的 Kanzi 帐户。当您希望在编辑器或代理中查询 Kanzi,或管理您的 Kanzi 许可证和帐户时,这非常有用。
快速设置¶
从您自己的 AI 编程代理使用 Kanzi 的最快方法是让代理自行完成设置。您的代理必须能够获取 URL,并能在您的计算机上编辑文件和运行命令。将以下内容粘贴到您的代理中:
Fetch https://docs.kanzi.com/agent-setup/prompt.md and follow it.
代理会读取说明并为您注册 Kanzi MCP 服务器:它会将服务器条目写入您的用户范围 MCP 配置,并直接运行设置命令,因此您无需手动配置任何内容。文档服务器和 API 服务器可立即使用;Portal 服务器还会在您的工具首次使用它时要求您登录 Kanzi 帐户。这适用于 Claude Code、VS Code、Cursor、Windsurf、Codex 以及任何其他支持 MCP 的工具。
代理完成后,开始新的聊天,以便您的工具加载新服务器。然后提出一个 Kanzi 问题以确认工具能够响应,例如:”使用 Kanzi 文档工具,Kanzi 4.1 中的数据源如何工作?”。
要改为手动配置服务器,请参阅 MCP 服务器。
Ask Kanzi¶
Ask Kanzi 基于 Documentation 和 API 参考,因此它根据经过验证的内容而非通用训练数据进行回答。您可以提出概念性问题(”数据源如何工作?”)、操作方法问题(”如何将属性绑定到数据源值?”)、API 问题(”Kanzi 4.1 中 kanzi::Node::setProperty 的签名是什么?”)或迁移问题(”Kanzi 3.9.15 和 4.0.0 之间渲染通道有哪些变化?”)。
需要了解的要点:
页面上下文。 当您从文档页面打开 Ask Kanzi 时,Ask Kanzi 会自动将该页面用作上下文,因此您无需复制粘贴即可就该页面提出后续问题。Ask Kanzi 会在聊天输入框上方以标签形式显示当前页面。点击标签上的 × 可将该页面从上下文中移除。
选中内容上下文。 在打开 Ask Kanzi 之前选中页面上的任意文本,该选中内容将成为附加上下文。当您想询问特定的代码片段、表格单元格或段落时,这非常有用。
版本。 Ask Kanzi 的回答基于与您打开它时所在文档页面相对应的 Kanzi 版本。
来源。 每个回答都会列出其所依据的文档页面。点击来源可在新标签页中打开该页面,并在上下文中验证回答。
在聊天中查找。 在面板标题栏中,点击放大镜图标并输入内容,即可在当前对话中查找文本。使用向上和向下箭头(或 Enter 和 Shift+Enter)逐个浏览找到的词语。按 Esc 或点击关闭按钮可清除高亮显示。
新聊天。 在面板标题栏中,点击铅笔图标可清除当前对话并开始新的聊天。
有关如何在同一文档中使用搜索的详细信息,请参阅 搜索 Documentation。
MCP 服务器¶
Kanzi MCP 服务器基于 Model Context Protocol (MCP) 构建,这是一种用于将 AI 助手连接到外部工具和数据源的开放标准。将 Kanzi MCP 服务器连接到您的 AI 助手后,助手即可使用该服务器提供的工具查找 Kanzi 信息并回答您的问题。
Kanzi 提供三个 MCP 服务器。文档服务器和 API 服务器是公开的:它们无需身份验证,并支持所有 Kanzi 版本,您可以在工具中选择版本。Portal 服务器连接到您的 Kanzi 帐户,因此需要您登录,并在您的 Kanzi Portal 权限范围内工作。
位于
https://docs.mcp.kanzi.com/mcp的 Kanzi 文档 MCP 服务器 将您的 AI 助手连接到 Kanzi 文档。使用它可以获取有关 Kanzi 概念、功能、工作流程和最佳实践的解答。位于
https://api.mcp.kanzi.com的 Kanzi API MCP 服务器 将您的 AI 助手连接到 Kanzi API 参考。使用它可以查找 API 签名、检查弃用状态、查找 include 指令,以及比较不同 Kanzi 版本之间的 API。位于
https://portal.kanzi.com/api/mcp的 Kanzi Portal MCP 服务器 将您的 AI 助手连接到您在 Kanzi Portal 中的 Kanzi 帐户。使用它可以通过自然语言查询和管理您的许可证、组织、下载、支持工单和 API 密钥。
添加服务器最快的方法是一步完成的 快速设置。要手动添加服务器,请使用您的工具的 MCP 配置:
AI 工具 |
如何添加服务器 |
|---|---|
Claude Code |
运行 |
VS Code |
将服务器添加到 |
Cursor |
将服务器添加到 |
Windsurf |
将服务器添加到 |
Claude Desktop |
安装一键式 |
Codex |
将服务器添加到 |
任何其他不具有直接 HTTP 支持的 MCP 工具 |
使用 |
对于文档服务器,使用 https://docs.mcp.kanzi.com/mcp 作为 <url>;对于 API 服务器,使用 https://api.mcp.kanzi.com;对于 Portal 服务器,使用 https://portal.kanzi.com/api/mcp。Portal 服务器需要具有原生 HTTP MCP 支持的工具,并需要登录一次;mcp-remote 桥接不适用于它。有关在各个工具中的完整分步配置,请参阅 Kanzi 文档 MCP 服务器、Kanzi API MCP 服务器 和 Kanzi Portal MCP 服务器。
使用 Kanzi AI 工具的技巧¶
提问要具体。例如,不要问“绑定是如何工作的?”,而要问“如何在 Kanzi Studio 中创建一个根据数据源的值更改节点颜色的绑定?”。
询问 API 用法时,请说明您使用的编程语言和 Kanzi 版本。大多数 MCP 服务器工具一次只针对一个 Kanzi 版本作答,并且不会在不同问题之间记住版本。如果您指明版本,助手会将其传递给工具。否则,工具将按可用的最新版本作答。
您可以请求验证 API 签名、检查弃用情况,以及为已弃用的 API 建议替代项。
在 Kanzi 版本之间迁移时,将 Kanzi API MCP 服务器与您的 AI 助手配合使用,以比较不同版本之间的 API。这有助于您确定发生了哪些更改,并估算迁移工作量。