Content
# Xiaozhi Client
[](https://www.npmjs.com/package/xiaozhi-client)
[](https://codecov.io/gh/shenjingnan/xiaozhi-client)
[](https://github.com/shenjingnan/xiaozhi-client/actions)
[](https://hub.docker.com/r/shenjingnan/xiaozhi-client)
[](https://qun.qq.com/universal-share/share?ac=1&authKey=c08PvS2zvAF1NN%2F%2BuaOi0ze1AElTIsvFBLwbWUMFc2ixjaZYxqZTUQHzipwd8Kka&busi_data=eyJncm91cENvZGUiOiIxMDU0ODg4NDczIiwidG9rZW4iOiJuSmJUN2cyUEVkNEQ5WXovM3RQbFVNcDluMGVibUNZTUQvL1RuQnFJRjBkZmRZQnRBRTdwU0szL3V2Y0dLc1ZmIiwidWluIjoiMzkxMTcyMDYwMCJ9&data=9cH6_zEC-sN3xYlwzKEWiYF71RLY9CId5taN-gy6XZo7axSlSWDpd1Ojui5hYMQKIgEJYSPw59XYgF5vH2wLog&svctype=4&tempid=h5_group_info)
[](https://opensource.org/licenses/MIT)
[](https://img.shields.io/badge/AI%20Code-90%25%2B-84cc16)
<br />
[](http://xiaozhi.me)
[](https://www.modelscope.cn/mcp)
[](https://www.coze.cn/)
<img src="https://raw.githubusercontent.com/shenjingnan/xiaozhi-client/main/docs/images/qq-group-qrcode.jpg" alt="QQ Group" width="300"/>
## Features
- Supports the official server access point of 小智 (xiaozhi.me)
- Supports integration as a regular MCP Server into clients like Cursor/Cherry Studio
- Supports configuration of multiple 小智 access points, allowing multiple 小智 devices to share a single MCP configuration
- Supports standard aggregation of multiple MCP Servers
- Supports dynamic control of the visibility of MCP Server tools to avoid anomalies in the 小智 server caused by excessive unused tools
- Supports integration of a localized deployed open-source server, allowing you to use the same RPC communication as the official 小智 server or directly use the standard MCP integration method
- Supports web-based visual configuration (allows custom IP and port, enabling you to deploy xiaozhi-client on device A and control it via the web on device B)
- Supports integration of ModelScope's remote MCP service
- Supports creating xiaozhi-client projects through templates (xiaozhi create \<my-app\> --template hello-world)
- Supports running in the background (xiaozhi start -d)
## Quick Start
You can read the documentation at [xiaozhi-client.shenjingnan.com](https://xiaozhi-client.shenjingnan.com) for a quick start!
### Local Installation
> Prerequisites: Please complete the installation of node:22 (LTS) and pnpm first.
```bash
# Installation
pnpm install -g xiaozhi-client
# Create Application
xiaozhi create my-app
# Enter the application directory
cd my-app
# Install Dependencies
pnpm install
# XiaoZhi AI Configuration MCP Endpoint [User Guide](https://ccnphfhqs21z.feishu.cn/wiki/HiPEwZ37XiitnwktX13cEM5KnSb)
xiaozhi config set mcpEndpoint "<The endpoint address obtained from the XiaoZhi server>"
# Start the Service
xiaozhi start
# Open the browser at http://localhost:9999. If you are using NAS deployment, please use http://<IP address of the deployment device>:9999.
### Running with Docker
We provide a pre-configured Docker image that allows you to quickly start the xiaozhi-client environment.
#### Prerequisites
- Docker must be installed
- The XiaoZhi access point address must be obtained (refer to [XiaoZhi AI Configuration MCP Access Point User Guide](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` as an alternative.
```bash
curl -fsSL https://gitee.com/shenjingnan/xiaozhi-client/raw/main/docker/scripts/start.sh | bash
```
##### Method 2: Using Docker Compose
Obtain 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` as an alternative.
```bash
curl -O https://gitee.com/shenjingnan/xiaozhi-client/raw/main/docker/docker-compose.yml
```
# Start with Docker Compose
docker-compose up -d
# View Logs
docker-compose logs -f
# Stop the Service
docker-compose down
```
## Contributors
MCP Store
