Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| HEADLESS | No | Whether to run the browser in headless mode. It is recommended to set this to 'false' for the first login to handle QR codes/captchas. | |
| PYTHONPATH | No | The path to the xhs-toolkit directory, required when running via python module mode. | |
| CHROME_PATH | Yes | The path to the Google Chrome binary executable. | |
| COLLECTION_SCHEDULE | No | Cron expression for scheduled data collection (e.g., '0 */6 * * *'). | |
| REMOTE_BROWSER_HOST | No | The host URL for the remote browser (e.g., http://xx.xx.xx.xx). | |
| REMOTE_BROWSER_PORT | No | The port for the remote browser connection. | |
| ENABLE_REMOTE_BROWSER | No | Enable remote browser connection (true/false). | |
| WEBDRIVER_CHROME_DRIVER | Yes | The path to the ChromeDriver executable, matching your Chrome version. |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
No tools | |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |