bot-status-api

What This Skill Does

The bot-status-api skill provides a lightweight, performant HTTP server designed to expose the internal state and operational health of your OpenClaw agent as a structured JSON object. It functions as a observability layer, gathering data from your agent’s workspace, local system resources, and external services. By aggregating metrics like context usage, heartbeat timing, active cron jobs, and service availability, it allows you to build real-time dashboards or integration status pages without adding complex dependencies to your core agent logic.

Installation

To install, use the command: clawhub install openclaw/skills/skills/suspect80/bot-status-api. After installation, move the provided server files to your directory of choice. You must create a config.json file in the root folder, defining the workspace and openclawHome paths so the server can track core metadata. To enable heartbeat tracking, ensure your agent is configured to write its current vitals (such as context usage and model version) to a heartbeat-state.json file within the agent's workspace folder. For long-term operation, follow the systemd instructions provided in the repository to register the script as a user service, ensuring it restarts automatically and survives user logouts.

Use Cases

• Monitoring Dashboards: Feed the JSON output into tools like Grafana, Uptime Kuma, or a custom web dashboard to see your agent's real-time health.
• Automated Alerting: Configure external health-check tools to ping the /status endpoint and notify you via Slack or Discord if the agent stops responding.
• Multi-Service Transparency: Combine your agent's status with checks for your local databases, Redis instances, or external APIs, providing a single source of truth for your development environment.
• Developer Productivity: Instantly verify if your agent has crashed or if it is currently stuck in a loop by checking the updatedAt heartbeat timestamp.

Example Prompts

• "List all active services monitored by my status API."
• "What is the current context usage of the agent according to the heartbeat-state.json?"
• "Restart the status API service via systemctl since the monitoring dashboard shows it is offline."

Tips & Limitations

This skill is built for local-first observability; it does not include built-in authentication, so it is recommended to keep the API behind a local firewall or proxy if exposed to the internet. Since it uses standard Node.js without heavy dependencies, keep your config.json clean and ensure the cache.ttlMs is set appropriately for your update frequency needs. Note that the system metrics rely on /proc, meaning this skill is primarily designed for Linux environments.