A lightweight, zero-dependency Node.js API to monitor Openclaw Skills health, system metrics, and agent connectivity.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install bot-status-api-test
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install bot-status-api-test using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is Bot Status API?
The Bot Status API provides a streamlined solution for observing the operational health of your AI agents. By exposing runtime metrics as a JSON endpoint, this skill allows developers to integrate agent performance data into custom dashboards or monitoring stacks. It acts as a bridge between the internal state of Openclaw Skills and external visibility tools.
This service ensures that critical agent components, from context usage to service connectivity, are always performing optimally. It is designed with a focus on high performance and low overhead, utilizing non-blocking background refreshes to serve data instantly. By maintaining a clear view of bot vitals, developers can ensure their automated workflows remain stable and efficient.
Bot Status API Use Cases
- Monitoring Openclaw Skills uptime and service health via a centralized dashboard.
- Setting up automated alerts for high context usage or model failures.
- Verifying the status of background cron jobs and dockerized services.
- Debugging connectivity issues between the agent and third-party APIs.
- Visualizing system-level metrics like CPU and RAM usage alongside agent performance.
How Bot Status API Works
- The API service reads configuration parameters from a local config file to define monitoring targets.
- Collectors gather data from the bot workspace, system resources, and external services asynchronously.
- An internal cache is updated periodically in the background to ensure performance.
- Clients query the status endpoint to receive a full JSON snapshot of the bot ecosystem.
- The bot updates its vital signs in a shared state file, which the API integrates into the final report.
Bot Status API Setup
1. File Preparation
Copy server.js, collectors/, and package.json to your server or local directory.
2. Configuration
Create your configuration file from the provided example:
cp config.example.json config.json
Edit config.json to specify your workspace path, model details, and the Openclaw Skills directory.
3. Launching the Service
Run the API using Node.js:
node server.js
4. Persistence
To ensure the monitoring stays active, enable the systemd user service:
systemctl --user enable --now bot-status
Bot Status API Data Schema & Taxonomy
The skill manages data through configuration files and runtime state snapshots to provide a holistic view of Openclaw Skills.
| Data Component | Format | Description |
|---|---|---|
| config.json | JSON | Defines ports, paths, and custom service health checks. |
| heartbeat-state.json | JSON | Stores runtime vitals like context usage and model version. |
| /status | API Endpoint | Returns a comprehensive JSON object of the entire bot state. |
| /health | API Endpoint | Returns a simple connectivity check for uptime monitoring. |
Bot Status API Advanced Features
- Multi-type health checks supporting HTTP 200 checks, shell command execution, and file-existence verification.
- Background refresh mechanism ensures ~10ms response times by serving requests from cache.
- Native integration with Openclaw Skills cron schedules for automated workflow transparency.
- Portainer API support for monitoring containerized agent environments.
- Automatic detection of running development servers using process-level grep operations.
SKILL.md
Loading
Related Openclaw Skills
Cron Doctor
A comprehensive diagnostic tool for identifying, triaging, and fixing cron job failures across Linux and macOS environments.
Goodreads
Automate book discovery, metadata extraction, and library management on Goodreads using advanced browser-based AI agent interactions.
Fastfish Lite
A lightweight content utility for WeChat formatting, local sensitive word detection, and automated daily hotspot pushes to IM channels.
fastfish-hot
A robust automated hotspot fetching system that synchronizes trending news to Telegram, Feishu, and DingTalk with keyword filtering and scheduling.
Agent Security Monitor
A proactive security auditing and alerting tool designed to shield AI agent environments from credential leaks, malicious commands, and supply chain vulnerabilities.
Soulseek P2P Communication & File Sharing
Soulseek provides a decentralized peer-to-peer network for AI agents to communicate and exchange files without custom infrastructure.
Featured*
