Mcp Server For 3x Ui
@pyworkload
MCP server for 3x-ui — an Xray/V2Ray proxy management panel. Exposes the 3x-ui HTTP API as MCP tools so LLMs can manage inbounds, clients, routing rules, Xray service, and server settings.
Overview
What is Mcp Server For 3x Ui?
An MCP server that exposes the 3x-ui (Xray/V2Ray proxy management panel) HTTP API as MCP tools, enabling LLMs to manage inbounds, clients, routing rules, Xray service, and server settings.
How to use Mcp Server For 3x Ui?
Add the server to your MCP config (claude_desktop_config.json or .mcp.json) with the go run command or a pre-built binary, and set the required environment variables: XUI_HOST, XUI_USERNAME, XUI_PASSWORD. Requires Go 1.23+ if using go run.
Key features of Mcp Server For 3x Ui
- 40 MCP tools covering the full 3x-ui API
- Automatic session management with transparent re-authentication
- Stdio transport for seamless LLM integration
- Zero external dependencies beyond the MCP SDK
Use cases of Mcp Server For 3x Ui
- Manage inbound connections: create, list, update, delete
- Manage clients: add, update, delete, reset traffic, view IPs
- Configure Xray routing rules and outbounds
- Monitor server status and restart Xray or the panel
- Reset traffic counters and clean depleted or expired clients
FAQ from Mcp Server For 3x Ui
What dependencies are required?
Go 1.23+ or a pre-built binary from the releases page.
How is the server configured?
Via environment variables: required XUI_HOST, XUI_USERNAME, XUI_PASSWORD, and optional XUI_BASE_PATH and XUI_LOG_LEVEL.
What transport does it use?
Stdio transport.
How does it authenticate with the 3x-ui panel?
Uses the provided admin username and password for session management with automatic re-authentication.
What can it not do?
The README does not specify limitations.
