1. Conduid
  2. Maps
  3. 3x Ui MCP
MCP server · Maps

3x Ui MCP

· github.com/pyworkload/3x-ui-mcp

MCP server for 3x-ui panel — manage inbounds, clients, routing and Xray via LLMs

Unclaimed 3x-uigolangmcpmcp-servermodel-context-protocolv2rayxray
InstallView source
34Low

Scored 5 months ago · breakdown

About 3x Ui MCP

3x Ui MCP is an MCP server in the Maps category: mCP server for 3x-ui panel — manage inbounds, clients, routing and Xray via LLMs.

Install

From source
git clone https://github.com/pyworkload/3x-ui-mcp

This server has no ConduID identity, so agent calls to it are not receipted. Pin the version you install and review the source before granting it credentials.

Tools (2)

Host groups, API tokens, client export/import, external links, Warp and NordVPNv3.5.0

Parameters not published.

Observability, client groups, bulk client state, inbound projections and fallbacksv3.5.0

Parameters not published.

Ask AI

✦

Ask AI about 3x Ui MCP

Powered by Claude · Grounded in docs

I know everything about 3x Ui MCP. Ask me about installation, configuration, usage, or troubleshooting.

Security checks

  • ✓README presentThe repository ships documentation.

5 checks have not been run yet.

README

3x-ui MCP Server

CI Release Go Report Card

MCP (Model Context Protocol) 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.

Features

  • 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

Usage

Add to your MCP config (claude_desktop_config.json or .mcp.json):

{
  "mcpServers": {
    "3x-ui": {
      "command": "go",
      "args": ["run", "github.com/pyworkload/3x-ui-mcp/cmd/xui-mcp@latest"],
      "env": {
        "XUI_HOST": "http://localhost:2053",
        "XUI_USERNAME": "admin",
        "XUI_PASSWORD": "your-password"
      }
    }
  }
}

Requires Go 1.23+. First run downloads and compiles automatically, subsequent runs use cache.

With pre-built binary

Download from Releases, then:

{
  "mcpServers": {
    "3x-ui": {
      "command": "/path/to/xui-mcp",
      "env": {
        "XUI_HOST": "http://localhost:2053",
        "XUI_USERNAME": "admin",
        "XUI_PASSWORD": "your-password"
      }
    }
  }
}

Configuration

Variable Required Description Example
XUI_HOST Yes Panel URL http://localhost:2053
XUI_USERNAME Yes Admin username admin
XUI_PASSWORD Yes Admin password admin
XUI_BASE_PATH No Panel base path (default: /) /xui/
XUI_LOG_LEVEL No Log level (default: info) debug, info, warn, error

MCP Tools

Inbound Management (5 tools)

Tool Description
list_inbounds List all inbound connections
get_inbound Get inbound by ID
create_inbound Create a new inbound
update_inbound Update an existing inbound
delete_inbound Delete an inbound

Client Management (14 tools)

Tool Description
add_client Add a client to an inbound
update_client Update client configuration
delete_client Delete a client by inbound ID and UUID
delete_client_by_email Delete a client by email
get_client_traffic Get client traffic stats by email
get_client_traffic_by_id Get client traffic stats by UUID
get_client_ips Get IPs used by a client
clear_client_ips Clear recorded client IPs
reset_client_traffic Reset traffic counters for a client
reset_all_traffics Reset all inbound traffic counters
reset_all_client_traffics Reset all client traffic counters
delete_depleted_clients Delete clients with exhausted traffic/expired
get_online_clients List currently connected clients
update_client_traffic Update client traffic limits

Server Management (11 tools)

Tool Description
server_status Get server system status (CPU, RAM, disk, uptime)
restart_xray Restart Xray service
stop_xray Stop Xray service
get_xray_config Get current Xray runtime configuration
get_xray_versions List available Xray versions
install_xray Install a specific Xray version
get_logs Get panel service logs
get_xray_logs Get Xray core logs
get_settings Get panel settings
get_default_xray_config Get default Xray configuration
restart_panel Restart the 3x-ui panel

Xray Configuration (10 tools)

Tool Description
get_xray_template Get Xray JSON template
update_xray_template Update Xray JSON template
get_routing_rules List all routing rules
add_routing_rule Add a routing rule
remove_routing_rule Remove a routing rule by index
update_routing_rule Update a routing rule by index
get_outbounds List all outbounds
get_outbounds_traffic Get outbound traffic statistics
reset_outbound_traffic Reset traffic for an outbound tag
test_outbound Test connectivity of an outbound

Architecture

cmd/xui-mcp/main.go        Entry point, config loading, signal handling
internal/config/            Configuration from environment variables
internal/xui/              HTTP client with session management
internal/handler/          MCP tool definitions and request handlers

Development

make test       # Run tests
make lint       # Run linters
make fmt        # Format code
make build      # Build binary

License

MIT

README copy captured when this server was indexed; it may lag the repository. The original is authoritative.

Questions

About 3x Ui MCP

How do I install 3x Ui MCP?

No package has been published for this server, so install it from source: clone the repository and follow its README.

Is 3x Ui MCP safe to use with an AI agent?

Its trust score is 34 out of 100 (low). It passes 1 of the 1 static security checks run so far. It has no ConduID identity yet, so agent calls to it are not receipted.

Is 3x Ui MCP still maintained?

Conduid hasn't recorded a commit date for this repository yet. Check the repository directly for recent activity.