Beszel

Provides an MCP interface to query Beszel's PocketBase backend data and statistics.

python

0

GitHub Stars

python

Language

7 months ago

First Indexed

3 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "red5d-beszel-mcp": {
      "command": "uv",
      "args": [
        "run",
        "beszel-mcp"
      ],
      "env": {
        "BESZEL_URL": "http://localhost:8090",
        "BESZEL_EMAIL": "your-email@example.com",
        "BESZEL_PASSWORD": "your-password"
      }
    }
  }
}

You can run Beszel’s MCP server to interact with Beszel’s PocketBase backend, giving you commands to list systems, containers, alerts, and to query statistics. It helps you monitor and explore your environment from a consistent MCP interface while keeping authentication and configuration centralized.

How to use

Use an MCP client to connect to the Beszel MCP server and call its tools to fetch data or statistics. You can list all monitored systems or containers, review alerts and alert history, and query statistics for specific systems or containers. Each tool is designed to be straightforward to invoke, so you can build dashboards or automation around Beszel data.

How to install

Prerequisites: you need Python installed on your system. A Python package manager is also required for installation. Optional but recommended: the uv package manager for automatic virtual environments.

# Install uv if you haven’t already
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install the Beszel MCP project in editable mode
uv pip install -e .

# Or run directly without installing
uv run python -m beszel_mcp

If you prefer plain Python tooling without uv, install the package with pip and run the module directly.

pip install -e .
# Or install dependencies for the MCP server
pip install fastmcp httpx

Configuration and usage notes

The server uses environment variables to connect to Beszel’s PocketBase backend and to authenticate admin users if needed. You can set these variables in your shell or in the environment where you run the MCP server.

Environment variables shown in the examples:

BESZEL_URL: URL of your Beszel/PocketBase instance (for example http://localhost:8090)
BESZEL_EMAIL (optional): Admin email for authentication
BESZEL_PASSWORD (optional): Admin password for authentication

Example start configurations

You can run the Beszel MCP server in different ways. Choose the approach that fits your setup and tooling.

# Using uv (recommended) with the Beszel MCP server
# Command line:
# uv run beszel-mcp

# Or with Python directly
# python -m beszel_mcp

# Or using uv with Python module
# uv run python -m beszel_mcp

# Standalone quick-start using uv
export BESZEL_URL="http://localhost:8090"
export BESZEL_EMAIL="your-email@example.com"
export BESZEL_PASSWORD="your-password"
uv run beszel-mcp

Available tools

list_systems

List all monitored systems with optional pagination, filters, and sorting.

list_containers

List all monitored containers with optional pagination, filters, and sorting.

list_alerts

List all alerts with optional pagination, filters, and sorting.

list_alert_history

List alert history with optional pagination, filters, and sorting.

query_system_stats

Query statistics for a specific system with optional time range and pagination.

query_container_stats

Query statistics for a specific container with optional time range and pagination.