> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scanova.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Available tools

> Scanova MCP 服务器向已连接的 AI 助手暴露的每一个工具。

<Note>
  **本页的信息来源。** 此列表直接转录自公开的 `trycon/scanova-mcp` 仓库中 [`src/mcp_http/registry.py`](https://github.com/trycon/scanova-mcp/blob/main/src/mcp_http/registry.py) 里的 `list_mcp_tools()`——也就是真正响应真实 MCP 客户端对 `https://mcp.scanova.io/mcp` 发起的 `tools/list` 调用的那段代码。它**并非**来自该仓库的 README，后者已经过时：README 只宣传了 7 个二维码管理工具，而部署的服务器实际在 8 个类别中注册了 42 个工具。下方每个工具的**类型**反映的是同一份文件中它真实的 MCP 注解（`readOnlyHint`/`destructiveHint`）。
</Note>

已连接的 AI 助手会先调用 `initialize`（服务器会报告 `protocolVersion: "2025-03-26"`、`serverInfo: { name: "scanova-mcp", version: "1.0.0" }`），然后调用 `tools/list` 来发现下方的全部内容，再针对每个工具调用 `tools/call`。全部 42 个工具都作用于您自己的 Scanova 账户，使用您客户端所用于身份验证的任意凭据（参见 [Setup](/zh/mcp/setup)）。

## Scanova 文档桥接

让助手可以在对话过程中实时查阅本文档站点。

| 工具               | 类型 | 说明                                                                                                                            |
| :--------------- | :- | :---------------------------------------------------------------------------------------------------------------------------- |
| `probe_docs_mcp` | 只读 | 检查与 Scanova 文档 MCP 服务器的连通性，并列出其可用工具。                                                                                          |
| `query_docs`     | 只读 | 搜索 Scanova 的 API 文档（`mode="search"`），或对文档执行只读的、类似文件系统的命令——`cat`、`head`、`rg`、`tree`、`jq`（`mode="filesystem"`），例如直接读取某个特定的参考页面。 |

## 二维码设计

| 工具                      | 类型 | 说明                                                                                |
| :---------------------- | :- | :-------------------------------------------------------------------------------- |
| `get_qr_design_options` | 只读 | 返回设计选项的完整目录——数据图案、渐变样式、定位点形状、外框、纠错级别和字体——以便助手在调用 `set_qr_design` 之前提供真实的选择。       |
| `set_qr_design`         | 写入 | 根据易读的命名参数（图案、颜色、定位点形状、外框、Logo 等）为一个已有二维码应用视觉设计。只有您指定的字段会更改——其余部分通过与该二维码当前设计合并来保留。 |

## 二维码管理

| 工具                         | 类型  | 说明                                                  |
| :------------------------- | :-- | :-------------------------------------------------- |
| `create_qr_code`           | 写入  | 创建一个新的二维码。                                          |
| `list_qr_codes`            | 只读  | 列出账户中的二维码和/或页面，支持分页和搜索；可筛选为仅二维码或仅页面。                |
| `update_qr_code`           | 写入  | 更新一个已有的二维码。                                         |
| `retrieve_qr_code`         | 只读  | 获取某个特定二维码的详情。                                       |
| `download_qr_code`         | 只读  | 将二维码图像下载为 PNG、JPG、PDF、SVG 或 EPS。                    |
| `activate_qr_code`         | 写入  | 启用一个二维码。                                            |
| `deactivate_qr_code`       | 写入  | 停用一个二维码。                                            |
| `delete_qr_code`           | 破坏性 | 永久删除一个二维码。                                          |
| `get_qr_categories`        | 只读  | 列出可用的二维码类别（URL、vCard、WiFi、Document、Social Media 等）。 |
| `download_qr_printable`    | 只读  | 为一个二维码生成适合打印的 PDF 版本。                               |
| `attach_form_to_qr`        | 写入  | 为一个二维码附加一个潜在客户捕获表单。                                 |
| `detach_form_from_qr`      | 写入  | 移除一个二维码上的潜在客户捕获表单。                                  |
| `attach_lead_list_to_qr`   | 写入  | 为一个二维码附加一个潜在客户列表以进行潜在客户捕获。                          |
| `detach_lead_list_from_qr` | 写入  | 移除一个二维码上的潜在客户列表。                                    |

## 分析数据

| 工具                  | 类型 | 说明                                     |
| :------------------ | :- | :------------------------------------- |
| `get_account_stats` | 只读 | 获取账户级的使用计数器——二维码总数、扫码总数、用户总数等。         |
| `get_qr_analytics`  | 只读 | 获取按设备、地理位置、日期及其他维度细分的二维码效果指标。          |
| `export_analytics`  | 只读 | 将二维码分析数据导出为 Excel 或 PDF 报告。            |
| `export_raw_scans`  | 只读 | 将逐行的扫码日志导出为 CSV 或 Excel，供自定义 BI 流水线使用。 |

## 文件夹管理

| 工具                              | 类型  | 说明                                                                      |
| :------------------------------ | :-- | :---------------------------------------------------------------------- |
| `create_folder`                 | 写入  | 创建一个新文件夹，用于组织二维码或页面。                                                    |
| `list_folders`                  | 只读  | 列出某个给定类型（`qr` 或 `page`）的所有文件夹。                                          |
| `update_folder`                 | 写入  | 重命名一个已有的文件夹。                                                            |
| `delete_folder`                 | 破坏性 | 删除一个文件夹。该工具自身的说明指示助手需先与您确认，被删除文件夹中所包含的二维码应移动到 Uncategorized，还是随文件夹一并删除。 |
| `move_qr_codes_to_folder`       | 写入  | 将多个二维码移动到某个文件夹中。                                                        |
| `unassign_qr_codes_from_folder` | 写入  | 将多个二维码从某个文件夹中移除（它们会变为 Uncategorized）。                                   |

## 表单

| 工具              | 类型  | 说明                      |
| :-------------- | :-- | :---------------------- |
| `list_forms`    | 只读  | 列出所有潜在客户捕获表单，可选按启用状态筛选。 |
| `retrieve_form` | 只读  | 获取某个特定表单的详细信息，包括其配置。    |
| `update_form`   | 写入  | 更新一个表单的名称或启用状态。         |
| `delete_form`   | 破坏性 | 永久删除一个表单。               |

## 潜在客户列表

| 工具                   | 类型  | 说明                                |
| :------------------- | :-- | :-------------------------------- |
| `list_lead_lists`    | 只读  | 列出所有潜在客户列表，可选按启用状态筛选。             |
| `retrieve_lead_list` | 只读  | 获取某个特定潜在客户列表的详细信息，包括其 webhook 配置。 |
| `update_lead_list`   | 写入  | 更新一个潜在客户列表的名称或启用状态。               |
| `delete_lead_list`   | 破坏性 | 永久删除一个潜在客户列表。                     |

## 用户管理

| 工具                 | 类型  | 说明               |
| :----------------- | :-- | :--------------- |
| `list_users`       | 只读  | 列出账户中的所有用户。      |
| `get_user`         | 只读  | 获取某个特定用户的详情。     |
| `add_user`         | 写入  | 通过邮箱邀请一个新用户加入账户。 |
| `remove_user`      | 破坏性 | 从账户中移除一个用户。      |
| `list_user_roles`  | 只读  | 列出所有可分配的用户角色。    |
| `update_user_role` | 写入  | 更改一个现有用户的角色。     |

<Warning>
  **破坏性工具会按设计跳过确认对话框**——MCP 协议没有内置的"您确定吗？"步骤；具体会出现什么样的确认，取决于您所用 AI 客户端自身的界面约定。在批准之前，请审查一次 `delete_*` 或 `remove_user` 工具调用即将执行的操作——就像您对委托给助手的任何其他写入操作一样。
</Warning>

## 相关内容

* [MCP overview](/zh/mcp/overview) — 该服务器是什么、它大致能做什么，以及其访问要求。
* [MCP setup](/zh/mcp/setup) — 将 AI 客户端连接到暴露这些工具的服务器。
* [Management API overview](/zh/api-reference/management-api/overview) — 这些工具代表您调用的底层 API。