Cloudron

Provides MCP access to Cloudron, enabling app listing, app detail retrieval, and instance status checks.

javascript

0

GitHub Stars

javascript

Language

5 months ago

First Indexed

2 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": {
    "serenichron-mcp-cloudron": {
      "command": "npx",
      "args": [
        "@serenichron/mcp-cloudron"
      ],
      "env": {
        "CLOUDRON_BASE_URL": "https://your-cloudron-instance.com",
        "CLOUDRON_API_TOKEN": "your-api-token"
      }
    }
  }
}

You can manage your Cloudron instance through an MCP server that lists apps, checks status, and retrieves detailed information about each application. This enables you to monitor health, view usage, and access configuration details from a unified interface.

How to use

Use an MCP client to connect to the Cloudron MCP server and perform common management tasks. You can run the MCP server locally to interact with your Cloudron instance using standard MCP client tooling. The server exposes tools to list all apps, fetch details for a specific app, and check the overall Cloudron status.

How to install

Prerequisites: you need Node.js and npm installed on your machine.

Install the MCP server package locally or run it directly with a package runner.

Additional configuration and usage notes

Environment variables you must provide to connect to your Cloudron instance are:

CLOUDRON_BASE_URL: Your Cloudron instance URL (for example, https://my.cloudron.io)
CLOUDRON_API_TOKEN: An API token from the Cloudron Admin Panel.

To run the server via a one-off command (using npx): you can execute the following in your terminal. This starts the MCP server and connects to your Cloudron instance using the provided environment values.

npx @serenichron/mcp-cloudron

Security and best practices

Keep your API token secure. Do not share tokens or expose them in public terminals. Rotate tokens periodically from the Cloudron Admin Panel and update the MCP server configuration accordingly.

Troubleshooting

If you encounter authentication errors, verify that CLOUDRON_BASE_URL is reachable and that CLOUDRON_API_TOKEN has the necessary permissions. Check network access from the machine running the MCP server and ensure the token has not expired.

Example workflows

List all apps on your Cloudron instance to review their status and memory usage.
Retrieve details for a specific app to inspect its configuration or health metrics.

Notes on deployment setups

You can run the MCP server in different environments. The examples below show common patterns you can adapt to your setup.

API endpoints overview

The server exposes endpoints to list apps, get app details by ID, and fetch the Cloudron status. Use your MCP client to interact with these endpoints through the standardized MCP protocol.

Available tools

cloudron_list_apps

List all installed applications on the Cloudron instance with status, health, and memory usage.

cloudron_get_app

Get detailed information about a specific application by its ID.

cloudron_get_status

Get the current status and configuration of the Cloudron instance.