xiaozhi-client

xiaozhi-client

小智AI客户端,目前主要用于MCP的对接

Stars: 159

Visit
 screenshot

Xiaozhi Client is a tool that supports integration with Xiaozhi official servers, acts as a regular MCP Server integrated into various clients, allows configuration of multiple Xiaozhi access points for shared MCP configuration, aggregates multiple MCP Servers in a standard way, dynamically controls MCP Server tool visibility, supports local deployment of open-source server integration, provides web-based visual configuration allowing customization of IP and port, integrates ModelScope remote MCP services, creates Xiaozhi Client projects through templates, and supports running in the background.

README:

Xiaozhi Client

npm version codecov CI Docker: Ready Join: QQ Group License: MIT AI Code: 80%
Xiaozhi AI: Supported ModelScope: Supported Coze: Supported MCP Client: Supported

QQ群

快速开始

你可以阅读文档 xiaozhi-client.shenjingnan.com 快速上手!

效果图

目录

  1. Xiaozhi Client
    1. 目录
    2. 功能特色
    3. 快速上手
      1. 使用 Docker 运行
    4. Web UI 配置界面
      1. 功能特性
      2. 启动 Web UI

功能特色

  • 支持 小智(xiaozhi.me) 官方服务器接入点
  • 支持 作为普通 MCP Server 集成到 Cursor/Cherry Studio 等客户端
  • 支持 配置多个小智接入点,实现多个小智设备共享一个 MCP 配置
  • 支持 通过标准方式聚合多个 MCP Server
  • 支持 动态控制 MCP Server 工具的可见性,避免由于无用工具过多导致的小智服务端异常
  • 支持 本地化部署的开源服务端集成,你可以使用和小智官方服务端一样的 RPC 通信或直接使用标准 MCP 集成方式
  • 支持 Web 网页可视化配置(允许自定义 IP 和端口,你能将 xiaozhi-client 部署在设备 A,然后在设备 B 通过网页控制 xiaozhi-client)
  • 支持 集成 ModelScope 的远程 MCP 服务
  • 支持 通过模板创建 xiaozhi-client 项目 (xiaozhi create <my-app> --template hello-world)
  • 支持 后台运行(xiaozhi start -d)

快速上手

前置条件:请先完成 node:22(LTS) 与 pnpm 的安装

# 安装
pnpm install -g xiaozhi-client

# 创建应用
xiaozhi create my-app

# 进入应用目录
cd my-app

# 安装依赖
pnpm install

# 小智AI配置MCP接入点的 [使用说明](https://ccnphfhqs21z.feishu.cn/wiki/HiPEwZ37XiitnwktX13cEM5KnSb)
xiaozhi config set mcpEndpoint "<从小智服务端获取到的接入点地址>"

# 启动服务
xiaozhi start

# 最后,请前往小智服务端,检查对应的接入点,刷新后是否能获取到工具列表

使用 Docker 运行

我们提供了预配置的 Docker 镜像,可以快速启动 xiaozhi-client 环境。

前置要求

快速启动

方式一:使用启动脚本(推荐)
curl -fsSL https://raw.githubusercontent.com/shenjingnan/xiaozhi-client/main/docker-start.sh | bash

无法访问 Github 可以使用 Gitee 替代

curl -fsSL https://gitee.com/shenjingnan/xiaozhi-client/raw/main/docker-start.sh | bash
方式二:使用 Docker Compose

获取 docker-compose.yml 文件:

curl -O https://raw.githubusercontent.com/shenjingnan/xiaozhi-client/main/docker-compose.yml

无法访问 Github 可以使用 Gitee 替代

curl -O https://gitee.com/shenjingnan/xiaozhi-client/raw/main/docker-compose.yml
# 使用 Docker Compose 启动
docker-compose up -d

# 查看日志
docker-compose logs -f

# 停止服务
docker-compose down

Web UI 配置界面

xiaozhi-client 提供了一个现代化的 Web UI 界面,让配置 MCP 服务更加直观和便捷。

Web UI 配置界面

功能特性

  • 🎨 现代化界面:基于 React + TypeScript + Tailwind CSS 构建
  • 🔧 可视化配置:直观的界面操作,无需手动编辑 JSON 文件
  • 🚀 实时连接状态:实时显示与小智服务器的连接状态
  • 📦 MCP 服务管理
    • 添加/编辑/删除 MCP 服务
    • 支持本地服务和 SSE 服务
    • 支持批量导入配置
  • ⚙️ 配置管理
    • 编辑连接参数(心跳间隔、超时时间等)
    • 管理 ModelScope API Key

启动 Web UI

# 启动 Web 配置界面
xiaozhi ui

# 或者在启动服务时同时启动 Web UI
xiaozhi start -u

启动后访问 http://localhost:9999 进行可视化配置。

贡献者

Contributors

For Tasks:

Click tags to check more tools for each tasks

For Jobs:

Alternative AI tools for xiaozhi-client

Similar Open Source Tools

For similar tasks

For similar jobs