xiaozhi-client 1.9.3 → 1.9.4-beta.1

package/docs/usage/coze-workflow.mdx

@@ -1,73 +0,0 @@
----
-title: 集成扣子工作流
-sidebarTitle: 集成扣子工作流
----
-
-<Note>
-  **前期准备**: 请先将 xiaozhi-client 升级到 1.7.4 及以上版本
-</Note>
-
-<Steps>
-  <Step title="获取扣子空间授权凭证">
-  打开 [扣子空间-API管理](https://www.coze.cn/open/oauth/sats) - 服务身份及凭证 - 添加
-
-  xiaozhi-client 所需的最小权限如下
-  <Note>如果你觉得一个个授权太麻烦，或者并没有特别敏感的数据，可以直接勾选所有权限</Note>
-
-| 权限 | 原因 | API文档 | client 版本 |
-| -------- | ------------------------------------- | --- | --- |
-| 团队空间管理 - listWorkspace | 在获取工作流列表时使用 | [/v1/workspaces](https://www.coze.cn/open/docs/developer_guides/list_workspace) | `>=1.7.2` |
-| 工作流 - listWorkflow | 在获取工作流列表时使用 | [/v1/workflows](https://www.coze.cn/open/docs/developer_guides/get_workflow_list) | `>=1.7.2` |
-| 工作流 - run | 在执行工作流时使用 | [/v1/workflow/run](https://www.coze.cn/open/docs/developer_guides/workflow_run) | `>=1.7.2` |
-  </Step>
-
-  <Step title="配置扣子凭证">
-  请在 `xiaozhi.config.json` 中添加你的扣子凭证
-  ```json xiaozhi.config.json
-  {
-    "platforms": {
-      "coze": {
-        "token": "<请在此处添加你的扣子凭证>"
-      }
-    },
-  }
-  ```
-  </Step>
-
-  <Step title="启动服务">
-    ```bash
-    xiaozhi start
-    ```
-  </Step>
-
-  <Step title="集成一个工作流">
-  请在浏览器中访问 `http://localhost:9999`
-  <Note>如果你安装在另一台设备上，请访问 `http://<你的IP地址>:9999`</Note>
-  <Frame caption="第一步：点击右侧 工作流集成 按钮">
-  <img src="/images/coze-workflow/config-workflow-step-1.png" alt="第一步：点击右侧 **工作流集成** 按钮" />
-</Frame>
-<br />
-  <Frame caption="第二步：在指定的工作流中点击 添加 按钮">
-  <img src="/images/coze-workflow/config-workflow-step-2.png" alt="第二步：在指定的工作流中点击 添加 按钮" />
-</Frame>
-<br />
-  <Frame caption="第三步：在 配置工作流参数 弹窗中配置此工作流的参数">
-  <img src="/images/coze-workflow/config-workflow-step-3.png" alt="第三步：在 配置工作流参数 弹窗中配置此工作流的参数" />
-</Frame>
-  </Step>
-
-    <Step title="测试效果">
-    使用你的硬件设备测试是否成功
-    <Note>
-    需要注意的是，由于扣子工作流通常比较耗时，因此 xiaozhi-client 超过8秒未响应后会自动返回友好的等待处理内容给服务端
-    不过不需要担心，xiaozhi-client 会在工作流正确响应后缓存响应数据，等到下次你询问 `是否有结果了？` 时，会自动返回缓存的结果
-    </Note>
-    </Step>
-</Steps>
-
-## FAQ
-
-### Q: 如果获取工作流入参？
-在 xiaozhi-client 配置的参数即为工作流开始节点所配置的输入字段
-可以在扣子中找到对应工作流，点击详情查看，将对应的参数配置到 xiaozhi-client 即可
-![获取工作流参数](/images/coze-workflow/get-parameter.png)

package/docs/usage/docker.mdx

@@ -1,99 +0,0 @@
----
-title: 使用 Docker 部署
-sidebarTitle: 使用 Docker 部署
----
-
-<Note>
-  **前期准备**:
-  在开始之前，你至少需要有一个小智硬件设备，并已添加至小智官方服务端。并且已准备好
-  Docker 环境
-</Note>
-
-## 安装方式
-
-### 方式一：使用启动脚本（推荐）
-
-<Note>
-  如果你的网络环境无法访问 github ，可以使用 gitee 进行安装
-</Note>
-<CodeGroup>
-  ```bash github
-  # 下载脚本
-  curl -fsSL https://raw.githubusercontent.com/shenjingnan/xiaozhi-client/main/docker/scripts/start.sh | bash
-  ```
-
-```bash gitee
-curl -fsSL https://gitee.com/shenjingnan/xiaozhi-client/raw/main/docker/scripts/start.sh | bash
-```
-
-</CodeGroup>
-
-### 方式二：使用 Docker Compose
-
-<Steps>
-  <Step title="获取 docker-compose.yml">
-    <CodeGroup>
-      ```bash github
-      curl -O https://raw.githubusercontent.com/shenjingnan/xiaozhi-client/main/docker/docker-compose.yml
-      ```
-
-      ```bash gitee
-      curl -O https://gitee.com/shenjingnan/xiaozhi-client/raw/main/docker/docker-compose.yml
-      ```
-    </CodeGroup>
-
-  </Step>
-
-  <Step title="启动服务">
-    <CodeGroup>
-    ```bash
-    docker-compose up -d
-    ```
-    </CodeGroup>
-  </Step>
-</Steps>
-
-### 方式三：手动启动
-
-<Steps>
-  <Step title="创建挂载点目录">
-    <CodeGroup>
-      ```bash macos / linux
-      mkdir -p ~/xiaozhi-client
-      ```
-    </CodeGroup>
-  </Step>
-
-  <Step title="拉取镜像并启动服务">
-    <CodeGroup>
-    ```bash
-    docker run -d \
-    --name xiaozhi-client \
-    -p 9999:9999 \
-    -v ~/xiaozhi-client:/workspaces \
-    --restart unless-stopped \
-    shenjingnan/xiaozhi-client
-    ```
-    </CodeGroup>
-  </Step>
-</Steps>
-
-## 管理接入点
-
-<Note>
-  在启动容器服务之后，我们需要配置小智接入点，才可以正常使用
-</Note>
-
-<Steps>
-  <Step title="打开管理界面">
-    如果你的容器和你的本机在一起，可以直接使用浏览器打开网址：http://localhost:9999
-    如果你是在单独的设备部署容器，请确保你的电脑和单独的容器设备在同一个局域网，然后打开对应IP地址：http://{容器IP}:9999
-  </Step>
-
-  <Step title="配置小智接入点">
-    TODO
-  </Step>
-  <Step title="重启服务">
-    TODO
-  </Step>
-</Steps>

package/docs/usage/modelscope.mdx

@@ -1,74 +0,0 @@
----
-title: 使用 魔搭社区 MCP
-sidebarTitle: 使用 魔搭社区 MCP
----
-
-由于 sse / streamable-http MCP 服务需要启动服务才能使用，但我们一般不太可能为每个 MCP 都启动一个 Docker。<br />
-魔搭社区很好的解决了这个问题，其提供的 MCP 服务托管能力，可以帮助我们简化管理 sse / streamable-http MCP 服务的成本。
-
-## 方法一：使用 Web 界面添加（推荐）
-<Note>如果你使用 docker 推荐使用此方法，Web 界面通过友好的 UI 交互能更简单的进行操作</Note>
-
-<Steps>
-  <Step title="启动服务">
-    <Note>在你安装好 xiaozhi-client 并创建好应用后，即可启动服务</Note>
-
-    ```bash
-    xiaozhi start
-    ```
-  </Step>
-
-  <Step title="配置魔搭社区访问令牌">
-  请在浏览器中访问 `http://localhost:9999`
-  <Note>如果你安装在另一台设备上，请访问 `http://<你的IP地址>:9999`</Note>
-
-  <Frame caption="第一步：点击左侧 全局配置 菜单">
-  <img src="/images/modelscope/step-1.png" alt="第一步：点击 全局配置 菜单" />
-</Frame>
-<br />
-
-  <Frame caption="第二步：点击 打开魔搭社区 按钮 获取访问令牌">
-  <img src="/images/modelscope/step-2.png" alt="第二步：点击 打开魔搭社区 按钮 获取访问令牌" />
-</Frame>
-<br />
-
-<Note>如果还没有访问令牌，可以点击左下角的 新建访问令牌 按钮</Note>
-  <Frame caption="第三步：复制访问令牌">
-  <img src="/images/modelscope/step-3.png" alt="第三步：复制访问令牌" />
-</Frame>
-
-<Note>配置完成后，需要重启服务才会生效喔~</Note>
-  <Frame caption="第四步：填入访问令牌，并点击 保存 按钮">
-  <img src="/images/modelscope/step-4.png" alt="第四步：填入访问令牌，并点击 保存 按钮" />
-</Frame>
-  </Step>
-
-  <Step title="添加魔搭社区 MCP">
-  打开 [魔搭社区 MCP 广场](https://www.modelscope.cn/mcp) - 选择任意MCP - 添加到 xiaozhi-client 中
-
-  重启服务即可使用了
-  </Step>
-</Steps>
-
-## 方法二：编辑配置文件手动添加
-
-你也可以选择直接修改配置文件
-
-<Steps>
-  <Step title="编辑配置文件">
-  打开 `xiaozhi.config.json` 文件
-  ```json xiaozhi.config.json
-  {
-    "modelscope": {
-      "apiKey": "<填写魔搭社区的访问令牌>"
-    }
-  }
-  ```
-  </Step>
-
-  <Step title="重新启动服务">
-    ```bash
-    xiaozhi start
-    ```
-  </Step>
-</Steps>

package/docs/usage/use-multi-xiaozhi-mcp-endpoints.mdx

@@ -1,77 +0,0 @@
----
-title: 配置多个小智接入点
-sidebarTitle: 配置多个小智接入点
----
-
-## 方法一：使用 Web 界面添加(推荐)
-<Note>如果你使用 docker 推荐使用此方法，Web 界面通过友好的 UI 交互能更简单的进行操作</Note>
-
-<Steps>
-  <Step title="启动服务">
-    <Note>在你安装好 xiaozhi-client 并创建好应用后，即可启动服务</Note>
-
-    ```bash
-    xiaozhi start
-    ```
-  </Step>
-
-  <Step title="添加一个接入点">
-  请在浏览器中访问 `http://localhost:9999`
-  <Note>如果你安装在另一台设备上，请访问 `http://<你的IP地址>:9999`</Note>
-
-  <Frame caption="第一步：点击 小智接入点 状态卡片右下角的 配置 按钮">
-  <img src="/images/use-multi-xiaozhi-mcp-endpoints/step-1.png" alt="第一步：点击 小智接入点 状态卡片右下角的 配置 按钮" />
-</Frame>
-
-<Note>获取小智官方服务端的接入点可以直接点击右侧的 `打开小智服务端` 按钮</Note>
-  <Frame caption="第二步：点击 添加小智服务端接入点 按钮">
-  <img src="/images/use-multi-xiaozhi-mcp-endpoints/step-2.png" alt="第二步：点击 添加小智服务端接入点 按钮" />
-</Frame>
-<br />
-
-  <Frame caption="第三步：在 添加接入点 弹窗中填入接入点，并点击 确定 按钮">
-  <img src="/images/use-multi-xiaozhi-mcp-endpoints/step-3.png" alt="第三步：在 添加接入点 弹窗中填入接入点，并点击 确定 按钮" />
-</Frame>
-
-<Note>新增的接入点，需要重启后才会生效喔~</Note>
-  <Frame caption="第四步：点击页面右侧的 重启服务 按钮">
-  <img src="/images/use-multi-xiaozhi-mcp-endpoints/step-4.png" alt="第四步：点击页面右侧的 重启服务 按钮" />
-</Frame>
-  </Step>
-
-  <Step title="测试效果">
-  打开 [小智服务端](https://xiaozhi.me/console/agents) - 找到对应设备 - 刷新接入点弹窗
-
-  检查小智服务端是否正确获取到启用的工具列表
-
-  <Frame caption="检查是否已经正确获取到有效工具了">
-  <img src="/images/use-multi-xiaozhi-mcp-endpoints/step-5.png" alt="检查是否已经正确获取到有效工具了" />
-</Frame>
-  </Step>
-</Steps>
-
-
-## 方法二：编辑配置文件手动添加
-
-你也可以选择直接修改配置文件实现接入点配置
-
-<Steps>
-  <Step title="编辑配置文件">
-  打开 `xiaozhi.config.json` 文件
-  ```json xiaozhi.config.json
-  {
-    "mcpEndpoint": [
-      "wss://api.xiaozhi.me/mcp/endpoint-1",
-      "wss://api.xiaozhi.me/mcp/endpoint-2",
-      "wss://api.xiaozhi.me/mcp/endpoint-3"
-    ]
-  }
-  ```
-  </Step>
-
-  <Step title="重新启动服务">
-    ```bash
-    xiaozhi start
-    ```
-  </Step>
-</Steps>

package/docs/usage/web-control.mdx

@@ -1,6 +0,0 @@
----
-title: 使用网页管理
-sidebarTitle: 使用网页管理
----
-
-使用网页管理