@clickzetta/cz-cli-darwin-x64 0.3.1

package/bin/skills/lakehouse-doc/references/DataSource_StarRocks.md

@@ -0,0 +1,35 @@
+# StarRocks 数据源配置指南
+
+## 概述
+
+StarRocks 是一个高性能、实时分析的分布式关系型数据库，它提供了低延迟的数据查询和高并发的数据摄入能力。通过配置 StarRocks 数据源，您可以实现对大数据的快速分析和实时处理，满足复杂的业务分析需求。
+
+## 参数配置
+
+配置 StarRocks 数据源时，需要提供以下信息以确保成功连接到 StarRocks 集群：
+
+* **数据源名称**：为您的 StarRocks 数据源指定一个唯一且易于识别的名称。
+* **JDBC 连接地址**：提供 StarRocks 集群的 JDBC 连接地址，格式通常为 `jdbc:starrocks://host:port/database`。例如：`jdbc:starrocks://sr-host:8030/mydatabase`。
+* **用户名**：输入用于连接 StarRocks 集群的用户名。
+* **密码**：提供对应用户名的数据库密码。
+* **数据源描述**：（可选）为数据源添加描述性信息，以帮助您或其他管理员理解该数据源的用途或特点。
+
+## 连接配置
+
+在连接配置方面，您可以选择以下连接方式之一：
+
+* **直连**：确保您输入的连接信息在公网可访问。如果源端开启了 IP 访问白名单，请确保数据集成服务的出口 IP 地址已被加入到白名单中，具体 IP 地址请联系技术支持人员。
+* **通过 SSH 隧道**：为了提高安全性，您可以选择通过 SSH 隧道连接到 StarRocks。启用此选项并提供以下 SSH 隧道相关的配置信息：
+  * **SSH 服务器地址**：提供 SSH 服务器的 IP 地址或域名。
+  * **SSH 端口**：指定 SSH 服务器监听的端口号，通常为 `22`。
+  * **用户名**：提供 SSH 服务器的登录用户名。
+  * **密码**：提供 SSH 服务器登录用户名对应的密码。
+
+## 注意事项
+
+* 确保所有提供的连接信息准确无误，并且 StarRocks 服务是可访问的。
+* 保护您的数据库凭证信息和 SSH 凭证信息，避免泄露给未经授权的人员。
+* 定期检查并更新您的数据源配置，以适应数据库结构的变化或新的安全要求。
+* 监控数据同步任务的运行状态，以便及时发现并解决可能出现的问题。
+
+配置完成后，您就可以在数据同步任务中选择此 StarRocks 数据源，进行数据的导入或导出操作。通过 SSH 隧道连接可以增强数据传输的安全性，特别是在处理敏感数据时。

package/bin/skills/lakehouse-doc/references/DataSource_TiDB.md

@@ -0,0 +1,36 @@
+# TiDB 数据源配置指南
+
+## 概述
+
+TiDB 是一个开源的分布式关系型数据库，它支持水平扩展和强一致性，适合构建在线事务处理和在线分析处理（HTAP）应用。通过配置 TiDB 数据源，您可以实现数据的高效同步和实时分析，满足多种业务场景的需求。
+
+## 参数配置
+
+配置 TiDB 数据源时，需要提供以下信息以确保成功连接到 TiDB 集群：
+
+* **数据源名称**：为您的 TiDB 数据源指定一个唯一且易于识别的名称。
+* **JDBC 连接地址**：提供 TiDB 集群的 JDBC 连接地址，格式通常为 `jdbc:tidb://host:port/database`。例如，`jdbc:tidb://tidb-server:4000/mypd`。
+* **用户名**：输入用于连接 TiDB 集群的用户名。
+* **密码**：提供对应用户名的数据库密码。
+* **允许使用配置信息连接所有数据库/Schema**（可选）：勾选此选项，使得配置信息可以用于连接到 TiDB 集群中的所有数据库和 Schema。如果未勾选，连接将仅限于指定的数据库/Schema。
+* **数据源描述**：（可选）为数据源添加描述性信息，以帮助您或其他管理员理解该数据源的用途或特点。
+
+## 连接配置
+
+在连接配置方面，您可以选择以下连接方式之一：
+
+* **直连**：确保您输入的连接地址在公网可访问。如果源端开启了IP访问白名单，请确保数据集成服务的出口IP地址已被添加到白名单中，具体IP地址请联系技术支持人员。
+* **通过 SSH 隧道**：为了提高安全性，您可以选择通过 SSH 隧道连接到 TiDB。启用此选项并提供以下 SSH 隧道相关的配置信息：
+  * **SSH 服务器地址**：提供 SSH 服务器的 IP 地址或域名。
+  * **SSH 端口**：指定 SSH 服务器监听的端口号，通常为 `22`。
+  * **用户名**：提供 SSH 服务器的登录用户名。
+  * **密码**：提供 SSH 服务器登录用户名对应的密码。
+
+## 注意事项
+
+* 确保所有提供的连接信息准确无误，并且 TiDB 服务是可访问的。
+* 保护您的数据库凭证信息和 SSH 凭证信息，避免泄露给未经授权的人员。
+* 定期检查并更新您的数据源配置，以适应数据库结构的变化或新的安全要求。
+* 监控数据同步任务的运行状态，以便及时发现并解决可能出现的问题。
+
+配置完成后，您就可以在数据同步任务中选择此 TiDB 数据源，进行数据的导入或导出操作。通过 SSH 隧道连接可以增强数据传输的安全性，特别是在处理敏感数据时。勾选“允许使用配置信息连接所有数据库/Schema”选项可以提供更大的灵活性，但请谨慎使用，以避免安全风险。

package/bin/skills/lakehouse-doc/references/Datalake_StorageConnection.md

@@ -0,0 +1,12 @@
+# 存储连接（Storage Connection）
+
+Storage Connection 是云器 Lakehouse 中 Connection 对象的一种类型，属于工作空间（workspace）级别的对象，用于存储从 Lakehouse 访问云对象存储（如阿里云 OSS、腾讯云 COS、亚马逊云 S3）、其他数据平台（如 Hive）以及实时流数据（如 Kafka）中的数据时所需的身份认证和访问控制信息。它是 Lakehouse Volume 对象、External Table、External Catalog 以及 Autoloader 等对象访问外部数据的前提条件。
+
+> 注意：如果未开通对象存储服务，同时需要通过文件方式上传数据至云器 Lakehouse，可以通过上传数据到 [内部Volume](internal_volume.md)。这种方式不需要用户开通云对象存储服务。
+
+### 使用限制：
+
+* 目前不支持跨云的对象存储连接。例如：开通的云器 Lakehouse 实例在阿里云上海站点，则此实例中不支持连接其他非阿里云的对象存储。
+* 一个对象存储的存储连接可以用于创建多个 Volume 对象。
+
+^

package/bin/skills/lakehouse-doc/references/Datasource_SQLServer.md

@@ -0,0 +1,36 @@
+# SQL Server 数据源配置指南
+
+## 概述
+
+SQL Server 是由微软提供的关系型数据库管理系统，它提供了强大的数据处理能力和广泛的应用支持。通过配置 SQL Server 数据源，您可以实现与其他系统的数据同步和集成。
+
+## 参数配置
+
+配置 SQL Server 数据源时，需要提供以下信息以确保成功连接到数据库：
+
+* **数据源名称**：为您的 SQL Server 数据源指定一个唯一且易于识别的名称。
+* **JDBC 连接地址**：提供 SQL Server 数据库的 JDBC 连接地址，格式通常为 `jdbc:sqlserver://host:port;databaseName=dbname`，例如：`jdbc:sqlserver://sqlserver-host:1433;databaseName=mydatabase`。
+* **用户名**：用于连接 SQL Server 数据库的用户名。
+* **密码**：对应用户名的数据库密码。
+* **Schema**：（可选）指定连接时默认使用的 Schema，例如 `dbo`。
+* **数据源描述**：（可选）为数据源添加描述性信息，以帮助您或其他管理员理解该数据源的用途或特点。
+
+## 连接配置
+
+在连接配置方面，您可以选择以下连接方式之一：
+
+* **直连**：确保您输入的连接信息在公网可访问。如果源端开启了 IP 访问白名单，请确保数据集成服务的出口 IP 地址已被添加到白名单中，具体 IP 地址请联系技术支持人员。
+* **通过 SSH 连接**：为了提高安全性，您可以选择通过 SSH 隧道连接到数据源。启用此选项后，需要提供 SSH 服务的 IP 地址和端口。请确保您的 SSH 客户端已正确配置，并且您有权限通过 SSH 连接到数据源所在的服务器。同时，您需要提供以下 SSH 隧道相关的配置信息：
+    * **SSH 服务器地址**：提供 SSH 服务器的 IP 地址或域名。
+    * **SSH 端口**：指定 SSH 服务器监听的端口号，通常为 `22`。
+    * **用户名**：提供 SSH 服务器的登录用户名。
+    * **密码**：提供 SSH 服务器登录用户名对应的密码。
+
+## 注意事项
+
+* 确保所有提供的连接信息准确无误，并且 SQL Server 服务是可访问的。
+* 保护您的数据库凭证信息，避免泄露给未经授权的人员。
+* 定期检查并更新您的数据源配置，以适应数据库结构的变化或新的安全要求。
+* 监控数据同步任务的运行状态，以便及时发现并解决可能出现的问题。
+
+完成配置后，您就可以在数据同步任务中选择此 SQL Server 数据源，进行数据的导入或导出操作。通过 SSH 隧道连接可以增强数据传输的安全性，特别是在处理敏感数据时。

package/bin/skills/lakehouse-doc/references/Datus_Lakehouse_Integrated_Guide.md

@@ -0,0 +1,3 @@
+
+
+

package/bin/skills/lakehouse-doc/references/Datus_Lakehouse_MCPServer.md

@@ -0,0 +1,111 @@
+# 配置和使用云器Lakehouse MCP Server
+
+## 高级配置
+
+### 1. 启用MCP工具集成
+
+如果您的环境支持MCP（Model Context Protocol）工具，可以通过命令行方式添加[MCP服务器](LakehouseMCPServer.md)：
+
+```bash
+# 添加HTTP类型的MCP服务器
+Datus> .mcp add --transport http clickzetta_mcp_http http://localhost:8002/mcp
+
+# 或者添加SSE类型的MCP服务器
+Datus> .mcp add --transport sse clickzetta_mcp_sse http://localhost:8003/sse
+
+# 查看已添加的MCP服务器列表
+Datus> .mcp list
+
+# 检查MCP服务器连接状态
+Datus> .mcp check clickzetta_mcp_http
+
+# 调用MCP工具（格式：服务器名.工具名，具体工具名请通过.mcp check查看）
+Datus> .mcp call clickzetta_mcp_http.工具名称
+
+# 配置工具过滤器（可选）
+Datus> .mcp filter set clickzetta_mcp_http --allowed 工具名1,工具名2 --enabled true
+
+# 查看工具过滤器配置
+Datus> .mcp filter get clickzetta_mcp_http
+
+# 删除MCP服务器（如需要）
+Datus> .mcp remove clickzetta_mcp_http
+```
+
+**MCP 命令说明**：
+
+* `.mcp list` - 查看所有 MCP 服务器
+* `.mcp check <name>` - 检查服务器连接状态并显示可用工具
+* `.mcp call <server.tool>` - 调用特定工具，格式为“服务器名.工具名”
+* `.mcp filter set <server> --allowed 工具名1,工具名2` - 设置允许的工具列表
+* `.mcp filter get <server>` - 查看当前过滤器配置
+* `.mcp remove <name>` - 删除 MCP 服务器
+
+**重要提示**：具体可用的工具名称需要先添加 MCP 服务器，然后通过 `.mcp check <server_name>` 命令查看。
+
+#### 通过subagent使用MCP工具（推荐方式）
+
+添加MCP服务器后，建议通过subagent来使用MCP工具，这样可以在添加过程中选择需要的工具：
+
+```bash
+# 添加subagent（会启动交互式向导）
+Datus> .subagent add
+
+# 查看所有配置的subagent
+Datus> .subagent list
+
+# 为subagent构建知识库（可选）
+Datus> .subagent bootstrap agent_name
+
+# 删除subagent（如需要）
+Datus> .subagent remove agent_name
+```
+
+**subagent 命令说明**：
+
+* `.subagent add` - 启动交互式向导添加新的智能代理，可以在此过程中选择 MCP 工具
+* `.subagent list` - 列出所有已配置的子代理
+* `.subagent bootstrap <agent_name>` - 为指定代理构建专门的知识库
+* `.subagent remove <agent_name>` - 删除指定的子代理
+
+**添加 subagent 时请设置**：
+
+```
+agent_description: ClickZetta Lakehouse assistant with MCP tool integration
+```
+
+```
+rules:
+      - Detect user intent: distinguish between analysis requests and SQL generation
+        requests
+      - For analysis/explanation requests: focus on interpreting results, use markdown
+        format
+      - For SQL generation requests: provide executable statements with explanations
+        in JSON format
+      - Use MCP tools for instance switching, job history, system operations,etc
+      - When users mention "instance switching", "job history", or similar operations
+        - call MCP tools
+      - Prefer specialized analysis tools over basic data collection tools when available
+      - Use single comprehensive tools over multiple basic tool combinations when
+        possible
+      - Choose tools designed for the specific analysis type rather than generic tools
+      - When using MCP analysis tools: focus on explaining the tool results rather
+        than auto-generating SQL
+```
+
+通过 subagent 方式使用 MCP 工具的优势：
+
+* 可以在添加过程中交互式选择需要的工具
+* 为每个场景创建专门的智能代理
+* 支持构建专门的知识库来提升分析能力
+
+**MCP 工具启用后的功能**：
+
+* 实例管理和切换
+* 作业历史查询
+* 高级数据分析工具
+* 系统监控功能
+
+***
+
+*本指南最后更新时间：2025 年 11 月*

package/bin/skills/lakehouse-doc/references/Dify_Integreated_with_LakehouseMCPServer.md

@@ -0,0 +1,71 @@
+# Dify中集成Lakehouse MCP Server
+
+Dify 的 Agent 应用中，支持直接集成来自外部 [MCP](https://modelcontextprotocol.io/introduction) 服务器的[工具](https://modelcontextprotocol.io/docs/concepts/tools)。这给Lakehouse与您的Dify AI应用集成提供了新方式。
+Lakehouse MCP Server通过这种方式实现和Dify的集成，来自Lakehouse MCP Server的丰富的工具可以在Dify 的 Agent 轻松调起来。
+
+## Dify MCP 服务器管理界面
+
+登录 Dify 后，在左侧导航栏中依次点击 **工具** → **MCP**，即可进入外部 MCP 服务器的管理页面。在这里，你可以统一管理所有为自身应用配置的 MCP 服务器。
+
+## 添加 Lakehouse MCP 服务器
+
+首先你需要部署支持[HTTP协议的Lakehouse MCP Server](LakehouseMCPServer_intro.md)
+
+:-: ![](.topwrite/assets/image_1756885164463.png =815)
+
+点击 **添加 MCP 服务器（HTTP**），即可集成Lakehouse MCP Server工具服务。需要填写如下信息：
+
+* **服务器 URL**：Lakehouse MCP 服务器的 HTTP 接口地址，例如集成 Notion 时为 `http://192.168.1.220:8001/mcp`。
+* **名称与图标**：自定义服务器名称，建议选择能清晰体现工具用途的名字。Dify 会自动尝试获取服务器域名的图标，你也可以手动上传。比如：clickzetta-mcp-server-mcp-220
+* **服务器标识符**：Dify 用于区分服务器的唯一 ID。规则：小写字母、数字、下划线或连字符，最多 24 个字符。比如clickzetta\_mcp\_mcp\_220
+
+服务器 ID 一旦创建即无法更改。如果更改服务器 ID，所有依赖该服务器工具的 Agent 或 Workflow 都会失效。这一设计对于[应用迁移](https://docs.dify.ai/zh-hans/guides/tools/mcp##application-portability)尤为重要。
+
+添加服务器后，Dify 会自动执行如下操作：
+
+1. **检测可用工具**：自动识别该服务器能提供哪些工具功能。
+2. **处理授权流程**：如服务器需要身份验证，则自动发起 OAuth 授权流程。
+3. **获取工具定义**：下载各工具的接口定义（schema）。
+4. **同步工具列表**：将识别到的工具加入 Agent 或Workflow应用的构建页面。
+
+当 Dify 成功获取到至少一个可用工具后，会在页面中显示该服务器的信息卡片：
+
+:-: ![](.topwrite/assets/image_1756885349165.png =806)
+
+## 管理已连接服务器
+
+点击对应服务器卡片，可进行以下操作：
+
+* **更新工具**：重新从服务器获取最新工具信息，适用于服务方新增或调整功能后更新。
+
+* **重新授权**：点击授权状态，更新服务器的访问权限（如令牌失效需重新授权）。
+
+* **编辑配置**：可修改服务器信息。
+
+更改服务器 URL 会触发重新授权，修改服务器 ID 会让已有应用失效！
+
+:-: ![](.topwrite/assets/image_1756885405845.png =478)
+
+* **移除服务器**：断开服务器连接。此后所有依赖该服务器工具的应用都会报错，直到你重新连接或删除相关工具。
+
+:-: ![](.topwrite/assets/image_1756885449635.png =473)
+
+当服务器配置完成后，其下的工具会出现在应用构建时的工具选择区：
+
+## 设计Agent 应用
+
+:-: ![](.topwrite/assets/image_1756885639345.png =816)
+
+* 在 Agent 配置界面，与内置工具并列显示 MCP 工具。
+* 可一键”添加全部”，快速启用该服务器下的所有工具。
+* 在Agent节点的指令部分，设置为： 你是clickzetta lakehouse资深产品专家，请帮助用户回答和解决问题。对于clickzetta lakehouse相关的问题，如果没有合适的tool，你需要先通过get\_product\_knowledge这个tool查产品知识库获得知识。作为产品专家，你不能编造任何假设性的产品知识和判断。一切要基于MCP tools的调用的知识和客观结果。
+
+## 发布Agent 应用
+
+:-: ![](.topwrite/assets/image_1756885966336.png =786)
+
+## 访问Agent 应用
+
+发布后，点击在'探索'中打开，在浏览器里访问Agent应用，这里可以按照对话内容调度起来Lakehouse MCP Server对应的tools。
+
+![](.topwrite/assets/image_1756886184934.png)