xiaozhi-client 1.6.11 → 1.6.12-beta.0

package/README.md

@@ -53,8 +53,6 @@
       1. [功能特性](#功能特性)
       2. [启动 Web UI](#启动-web-ui)
    9. [作为 MCP Server 集成到其他客户端](#作为-mcp-server-集成到其他客户端)
-      1. [方式一：使用 stdio 模式（推荐）](#方式一使用-stdio-模式推荐)
-      2. [方式二：使用 HTTP Server 模式](#方式二使用-http-server-模式)
 
 ## 功能特色
 
@@ -753,7 +751,7 @@ xiaozhi start -u
 
 ## 作为 MCP Server 集成到其他客户端
 
-> 需升级至 `1.5.0` 及以上版本
+> 需升级至 `1.6.12` 及以上版本
 
 xiaozhi-client 不仅可以作为小智 AI 的客户端使用，还可以作为标准的 MCP Server 被 Cursor、Cherry Studio 等支持 MCP 协议的客户端集成。
 
@@ -764,74 +762,32 @@ xiaozhi-client 不仅可以作为小智 AI 的客户端使用，还可以作为
 ![在CherryStudio中集成](https://raw.githubusercontent.com/shenjingnan/xiaozhi-client/main/docs/images/integrate-to-cherry-studio.png)
 ![在Cursor中集成](https://raw.githubusercontent.com/shenjingnan/xiaozhi-client/main/docs/images/integrate-to-cursor.png)
 
-### 方式一：使用 stdio 模式（推荐）
+### 使用方式
 
-第一步：确保已全局安装 xiaozhi-client：
+> 如果你将 xiaozhi-client 装在 docker 中使用，可以通过 HTTP 的方式暴露给外部客户端
 
-```bash
-npm install -g xiaozhi-client
-```
-
-第二步：在 客户端 的 MCP 配置中添加：
-
-```json
-{
-  "mcpServers": {
-    "xiaozhi-client": {
-      "command": "xiaozhi",
-      "args": ["start", "--stdio"]
-    }
-  }
-}
-```
-
-提示：如果需要指定配置文件位置，可以使用环境变量
-
-配置文件的查找顺序
-
-1. 当前工作目录
-2. 通过 `XIAOZHI_CONFIG_DIR` 环境变量指定的目录
-
-```json
-{
-  "mcpServers": {
-    "xiaozhi-client": {
-      "command": "xiaozhi",
-      "args": ["start", "--stdio"],
-      "env": {
-        "XIAOZHI_CONFIG_DIR": "/path/to/your/config/directory"
-      }
-    }
-  }
-}
-```
-
-### 方式二：使用 HTTP Server 模式
-
-> 如果你将 xiaozhi-client 装在 docker 中使用，可以通过 http server 的方式暴露给外部客户端
-
-第一步：启动 xiaozhi-client 的 HTTP Server：
+第一步：启动 xiaozhi-client 服务：
 
 ```bash
-# 使用默认端口 3000
-xiaozhi start -s
-
-# 使用自定义端口
-xiaozhi start -s 8080
-
-# 后台运行
-xiaozhi start -s -d
+# 使用默认端口 9999
+xiaozhi start
 ```
 
-第二步：在 客户端 中配置 SSE 连接：
+第二步：在客户端中配置 HTTP 连接：
 
 ```json
 {
   "mcpServers": {
     "xiaozhi-client": {
-      "type": "sse",
-      "url": "http://localhost:3000/sse"
+      "type": "streamableHttp",
+      "url": "http://localhost:9999/mcp"
     }
   }
 }
 ```
+
+**说明：**
+- 服务启动后，MCP 端点将在 `http://localhost:9999/mcp` 提供服务
+- 支持标准的 MCP over HTTP 协议
+- 可以通过 `--port` 参数自定义端口号
+- 使用 `-d` 参数可以后台运行服务