Connect Komari to Your AI Agent

Choose a node and period to investigate, then ask AI to explain the CPU, memory, or network history available.

71 tools API key

Try a Komari Task

Copy a prompt into your agent with the oo Skill installed. Add your page links and source notes before running it.

oo Skill Komari

Summarize a node’s resource history

Read persisted metrics for a selected node and explain the patterns in the available records.

/oo Komari: List Komari nodes, then read CPU and RAM history for node [UUID] over the last 24 hours. Summarize utilization patterns and any gaps. Make no configuration changes.

Start Working with Komari

  1. Install OOMOL

    Set up oo CLI and the oo Skill in your agent.

    Install OOMOL →
  2. Connect Komari

    Connect a dedicated Komari API key and the public instance URL for Komari 1.3.2 or newer.

    Connect Komari →
  3. Give Your Agent a Task

    Use /oo with the pages to read, the changes to make, and where to save the result.

    Connection Guide →

Choose Your Agent

  • A publicly reachable Komari 1.3.2 or newer instance.
  • A dedicated Komari API key, which grants administrator-level access.

Komari Tools

Komari exposes node metrics, ping history, and administration operations. This connection can read monitoring data and change server configuration with administrator-level API access.

Node monitoring data

Read visible nodes, recent reports, persisted resource history, and ping history.

71 tools

Get Current User

Get the current Komari user or guest identity.

komari.get_current_user

List Nodes

List visible Komari nodes without client tokens or private address fields.

komari.list_nodes

Get Public Settings

Get settings that Komari exposes to its public frontend.

komari.get_public_settings

Get Version

Get the Komari server version and build hash.

komari.get_version

Get Recent Metrics

Get the short in-memory window of recent reports for a node.

komari.get_recent_metrics

Get Load History

Get persisted resource metrics for a node.

komari.get_load_history

Get Ping History

Get ping records by node, task, or both.

komari.get_ping_history

List Public Ping Tasks

List ping tasks using the public response shape.

komari.list_public_ping_tasks

List Public Metric Definitions

List public metric definitions and retention policies.

komari.list_public_metric_definitions

Query Metrics

Query metric time-series points with filters, aggregation, and downsampling.

komari.query_metrics

Get Ping Metric Stats

Get aggregate latency, loss, percentile, and standard-deviation statistics.

komari.get_ping_metric_stats

Record Visitor Event

Record a bounded visitor audit event in Komari.

komari.record_visitor_event

Add Client

Create a Komari client. The response contains its enrollment token.

komari.add_client

Edit Client

Update client fields. This changes Komari configuration.

komari.edit_client

Remove Client

Permanently delete a client and its runtime state.

komari.remove_client

Get Client

Get one client without returning its enrollment token.

komari.get_client

List Clients

List all clients without returning enrollment tokens.

komari.list_clients

Get Client Token

Get a client enrollment token. Treat the response as a secret.

komari.get_client_token

Clear Records

Permanently delete all load records.

komari.clear_records

Get Clipboard

Get one clipboard entry.

komari.get_clipboard

List Clipboard

List clipboard entries.

komari.list_clipboard

Create Clipboard

Create a clipboard entry.

komari.create_clipboard

Update Clipboard

Update a clipboard entry.

komari.update_clipboard

Delete Clipboard

Delete a clipboard entry.

komari.delete_clipboard

Batch Delete Clipboard

Delete multiple clipboard entries.

komari.batch_delete_clipboard

Get Database Size

Inspect main and monitoring database storage.

komari.get_database_size

Vacuum Database

Run database maintenance and reclaim storage space.

komari.vacuum_database

List Metric Definitions

List all metric definitions and retention policies.

komari.list_metric_definitions

Update Metric Definition

Change a metric retention policy; zero deletes stored data for that metric.

komari.update_metric_definition

Get Metric Migration Status

Get metric-store migration progress.

komari.get_metric_migration_status

Start Metric Migration

Start migrating metrics from a source store into the current store.

komari.start_metric_migration

Cancel Metric Migration

Cancel the active metric-store migration.

komari.cancel_metric_migration

List Sessions

List login sessions using stable identifiers while redacting session tokens and IP addresses.

komari.list_sessions

Delete Session

Revoke one login session using the stable identifier returned by list_sessions.

komari.delete_session

Delete All Sessions

Revoke all login sessions.

komari.delete_all_sessions

Get Settings

Get all Komari settings. The result can contain secrets and database DSNs.

komari.get_settings

Edit Settings

Update arbitrary Komari settings; invalid database settings can disrupt service.

komari.edit_settings

Clear All Records

Permanently delete all load and ping records.

komari.clear_all_records

Order Clients

Set client display weights using a UUID-to-weight map.

komari.order_clients

Add Load Notification

Create a load notification rule.

komari.add_load_notification

Delete Load Notification

Delete load notification rules.

komari.delete_load_notification

Edit Load Notification

Replace load notification rule fields.

komari.edit_load_notification

List Load Notifications

List load notification rules.

komari.list_load_notifications

List Offline Notifications

List offline notification rules.

komari.list_offline_notifications

Edit Offline Notifications

Replace offline notification rule fields.

komari.edit_offline_notifications

Enable Offline Notifications

Enable offline notifications for clients.

komari.enable_offline_notifications

Disable Offline Notifications

Disable offline notifications for clients.

komari.disable_offline_notifications

List Traffic Report Notifications

List traffic-report rules.

komari.list_traffic_report_notifications

Edit Traffic Report Notifications

Replace traffic-report rule fields.

komari.edit_traffic_report_notifications

Enable Traffic Report Notifications

Enable traffic reports for clients.

komari.enable_traffic_report_notifications

Disable Traffic Report Notifications

Disable traffic reports for clients.

komari.disable_traffic_report_notifications

Add Ping Task

Create a ping task.

komari.add_ping_task

Delete Ping Tasks

Delete ping tasks and their records.

komari.delete_ping_tasks

Edit Ping Tasks

Replace ping task fields.

komari.edit_ping_tasks

List Ping Tasks

List all ping tasks including targets.

komari.list_ping_tasks

Order Ping Tasks

Set ping-task weights using an ID-to-weight map.

komari.order_ping_tasks

Get Message Sender Provider

Get one message-sender configuration or list available templates. The result may contain secrets.

komari.get_message_sender_provider

Set Message Sender Provider

Save and possibly reload a message-sender provider configuration.

komari.set_message_sender_provider

Get Oidc Provider

Get one OIDC configuration or list templates. The result may contain client secrets.

komari.get_oidc_provider

Set Oidc Provider

Save and possibly reload an OIDC provider configuration.

komari.set_oidc_provider

List Audit Logs

List paged audit logs.

komari.list_audit_logs

Execute Command

DANGEROUS: execute a shell command on selected clients. Komari API keys bypass interactive 2FA for this sensitive RPC.

komari.execute_command

Test Message Sender

Send a test notification through the active message sender.

komari.test_message_sender

Test Geoip

Test Komari GeoIP lookup.

komari.test_geoip

List Execution Tasks

List remote execution tasks and their results, which may contain command output.

komari.list_execution_tasks

Get Execution Task

Get one remote execution task and its results.

komari.get_execution_task

List Client Execution Tasks

List execution tasks assigned to a client.

komari.list_client_execution_tasks

Get Client Task Result

Get one client's result for an execution task.

komari.get_client_task_result

List Task Results

List all client results for an execution task.

komari.list_task_results

Get Terminal Settings

Get xterm.js terminal appearance settings.

komari.get_terminal_settings

Set Terminal Settings

Update xterm.js terminal appearance settings, including optional custom CSS.

komari.set_terminal_settings

Frequently Asked Questions

How much history can I request at once?

Resource history accepts up to 168 recent hours. Availability depends on records retained by your instance.

Is recent-report data the same as persisted history?

No. Recent reports cover a short in-memory window; load history reads persisted resource metrics.

What permissions does the API key have?

It grants administrator-level API access, including configuration changes and remote execution operations. Use a dedicated key and state the intended actions clearly.

Connect Komari

About Komari ↗