Content
<br />
<div align="center">
<img style="height: 60px;" src="https://raw.githubusercontent.com/shenjingnan/xiaozhi-client/main/docs/public/images/logo.png" alt="xiaozhi-client logo" />
</div>
<br />
<div align="center">
<a href="https://www.npmjs.com/package/xiaozhi-client" target="_blank"><img src="https://img.shields.io/npm/v/xiaozhi-client" alt="npm version" /></a>
<a href="https://codecov.io/gh/shenjingnan/xiaozhi-client" target="_blank"><img src="https://codecov.io/gh/shenjingnan/xiaozhi-client/branch/main/graph/badge.svg" alt="codecov" /></a>
<a href="https://github.com/shenjingnan/xiaozhi-client/actions" target="_blank"><img src="https://github.com/shenjingnan/xiaozhi-client/workflows/Release/badge.svg" alt="ci" /></a>
<a href="https://hub.docker.com/r/shenjingnan/xiaozhi-client" target="_blank"><img src="https://img.shields.io/badge/Docker-Ready-2496ED?style=flat&logo=docker&logoColor=white" alt="Docker: Ready" /></a>
<a href="https://opensource.org/licenses/MIT" target="_blank"><img src="https://img.shields.io/badge/License-MIT-green.svg" alt="License: MIT" /></a>
<a href="https://img.shields.io/badge/AI%20Code-90%25%2B-84cc16" target="_blank"><img src="https://img.shields.io/badge/AI%20Code-90%25%2B-84cc16" alt="AI Code: 80%" /></a>
<br />
<a href="http://xiaozhi.me" target="_blank"><img src="https://img.shields.io/badge/小智AI-Supported-84cc16?style=flat" alt="Xiaozhi AI: Supported" /></a>
<a href="https://www.modelscope.cn/mcp" target="_blank"><img src="https://img.shields.io/badge/ModelScope-Supported-84cc16?style=flat" alt="ModelScope: Supported" /></a>
<a href="https://www.coze.cn/" target="_blank"><img src="https://img.shields.io/badge/Coze-Supported-84cc16?style=flat" alt="Coze: Supported" /></a>
<a href="https://dify.ai/" target="_blank"><img src="https://img.shields.io/badge/Dify-Supported-84cc16?style=flat" alt="Dify: Supported" /></a>
<a href="https://img.shields.io/badge/MCP%20Client-Supported-84cc16?style=flat" target="_blank"><img src="https://img.shields.io/badge/MCP%20Client-Supported-84cc16?style=flat" alt="MCP Client: Supported" /></a>
</div>
## Features
- Supports official Xiaozhi(xiaozhi.me) server access points
- Supports integration as a regular MCP Server into clients like Cursor/Cherry Studio
- Supports configuring multiple Xiaozhi access points to allow multiple Xiaozhi devices to share a single MCP configuration
- Supports aggregating multiple MCP Servers in a standard way
- Supports dynamically controlling the visibility of MCP Server tools to avoid Xiaozhi server exceptions caused by too many useless tools
- Supports integration with locally deployed open-source servers, allowing you to use the same RPC communication as the official Xiaozhi server or directly use standard MCP integration
- Supports Web-based visual configuration (allowing custom IP and port settings, you can deploy xiaozhi-client on device A and then control xiaozhi-client through a webpage on device B)
- Supports integration with ModelScope's remote MCP service
- Supports creating xiaozhi-client projects from templates (xiaozhi create \<my-app\> --template hello-world)
- Supports running in the background (xiaozhi start -d)
## Quick Start
You can read the documentation [xiaozhi-client.shenjingnan.com](https://xiaozhi-client.shenjingnan.com) to get started quickly!
### Local Installation
> Prerequisites: Please complete the installation of node:22(LTS) and pnpm first
```bash
# 安装
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
# 浏览器打开 http://localhost:9999 如果你使用的是NAS部署请使用 http://<部署设备的IP地址>:9999
```
### Running with Docker
We provide a pre-configured Docker image to quickly start the xiaozhi-client environment.
#### Prerequisites
- Docker is installed
- Xiaozhi access point address has been obtained (see [小智 AI 配置 MCP 接入点的使用说明](https://ccnphfhqs21z.feishu.cn/wiki/HiPEwZ37XiitnwktX13cEM5KnSb))
#### Quick Start
##### Method 1: Using the startup script (recommended)
```bash
curl -fsSL https://raw.githubusercontent.com/shenjingnan/xiaozhi-client/main/docker/scripts/start.sh | bash
```
> If you cannot access `Github`, you can use `Gitee` instead
```bash
curl -fsSL https://gitee.com/shenjingnan/xiaozhi-client/raw/main/docker/scripts/start.sh | bash
```
##### Method 2: Using Docker Compose
Get the docker-compose.yml file:
```bash
curl -O https://raw.githubusercontent.com/shenjingnan/xiaozhi-client/main/docker/docker-compose.yml
```
> If you cannot access `Github`, you can use `Gitee` instead
```bash
curl -O https://gitee.com/shenjingnan/xiaozhi-client/raw/main/docker/docker-compose.yml
```
```bash
# 使用 Docker Compose 启动
docker-compose up -d
# 查看日志
docker-compose logs -f
# 停止服务
docker-compose down
```
## Contributors
