This repository has been archived on 2026-06-09. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
wiki/monitor-mcp/Tools-Reference.-.md
T
2026-05-09 19:09:43 -05:00

78 lines
3.1 KiB
Markdown

<![CDATA[← [Home](Home)
# Tools Reference
## SSH Monitoring
| Tool | Description |
|------|-------------|
| `monitor_health` | Full health check (uptime, disk, mem, cpu) |
| `monitor_disk` | Disk usage details |
| `monitor_memory` | Memory and swap usage |
| `monitor_processes` | Top processes by CPU or memory |
| `monitor_service` | Check systemd service status |
| `monitor_logs` | Tail a log file |
| `monitor_uptime` | Server uptime and load |
| `monitor_list_servers` | List configured servers |
| `monitor_docker` | List Docker containers with status |
| `monitor_docker_stats` | Docker container CPU/memory stats |
| `monitor_network` | Network connections and listening ports |
| `monitor_failed_logins` | Recent failed SSH login attempts |
| `monitor_cron` | List active cron jobs |
| `monitor_reboot_required` | Check if server needs a reboot |
| `monitor_updates` | Check available system updates |
| `monitor_journal` | Query systemd journal for a service |
## Sites Management (sites.json)
| Tool | Description |
|------|-------------|
| `monitor_sites` | List all monitored sites from sites.json |
| `monitor_site_add` | Add a new site endpoint to monitoring |
| `monitor_site_remove` | Remove a site from monitoring |
### monitor_site_add parameters
| Parameter | Required | Description |
|-----------|----------|-------------|
| `name` | Yes | Unique site name (e.g. `clientname-live`, `clientname-dev`) |
| `url` | Yes | Site URL (e.g. `https://example.com`) |
| `type` | Yes | Site type: `joomla`, `dolibarr`, `gitea`, `grafana`, `generic` |
| `client` | Yes | Client name label (groups endpoints in Grafana) |
| `joomlaToken` | No | Joomla API token for version/extension/update monitoring |
| `akeebaSecret` | No | Akeeba Backup frontend secret word for backup monitoring |
| `tlsVerify` | No | Verify TLS certificates (default: true, set false for self-signed) |
### Workflow: Add a new client
```
# 1. Add live and dev endpoints
monitor_site_add(name: "newclient-live", url: "https://newclient.com", type: "joomla", client: "NewClient", joomlaToken: "...")
monitor_site_add(name: "newclient-dev", url: "https://newclient.dev.mokoconsulting.tech", type: "joomla", client: "NewClient", joomlaToken: "...", tlsVerify: false)
# 2. Run generate-targets.sh to update Prometheus + joomla-monitor
# 3. Copy generated files to server -- Prometheus auto-discovers within 5 min
```
## Grafana
| Tool | Description |
|------|-------------|
| `grafana_health` | Check Grafana instance health |
| `grafana_dashboards` | List all dashboards |
| `grafana_dashboard_get` | Get dashboard by UID |
| `grafana_datasources` | List datasources |
| `grafana_alerts` | List active alerts |
| `grafana_alert_rules` | List alert rules |
| `grafana_query` | Query a datasource (SQL/PromQL) |
| `grafana_annotations` | List annotations |
]]>
---
*Repo: [monitor-mcp](https://git.mokoconsulting.tech/MokoConsulting/monitor-mcp) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
| Revision | Date | Author | Description |
|---|---|---|---|
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |