mcpField
C
cx-search-dashboard

cx-search-dashboard

github.com/coralogixCloud & DevOps2154.1k installsUpdated today
Repository

About cx-search-dashboard

cx-search-dashboard is a skill for finding Coralogix dashboards and widgets through the `cx dashboards` CLI. It helps teams check existing dashboards before creating new ones and inspect query patterns for reuse.

Key features

  1. 01Search dashboards by natural-language description
  2. 02Find widgets by query description or field
  3. 03List dashboards and retrieve definitions
  4. 04Export results as JSON or TOON
  5. 05Inspect and clone a found dashboard

Use cases

  1. 01Check whether a service dashboard already exists
  2. 02Find widgets covering a monitoring topic
  3. 03Reuse queries that reference a specific field
  4. 04Retrieve a dashboard definition to modify or clone

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/coralogix/cx-cli --skill cx-search-dashboard

After installing, type/cx-search-dashboardin Claude Code to confirm it loaded.

Details

From the project README

Dashboard Search Skill

Use this skill to discover existing Coralogix dashboards and widgets using semantic or field-based search via the cx dashboards CLI commands. Before creating a new dashboard, always search first to avoid duplication.

CLI Commands

CommandPurposeKey flags
cx dashboards search "<description>"Find dashboards by natural-language description--limit
cx dashboards query-search --description "<text>"Find widgets whose queries match a description--limit
cx dashboards query-search --field "<field-path>"Find all widgets that reference a specific field--limit
cx dashboards catalog -o jsonList all dashboards-
cx dashboards get <id> -o jsonGet full dashboard definition-

Output format: append -o json or -o toon for machine-readable output.

When to Use Each Command

GoalCommand
Check if a dashboard for a service or topic already existscx dashboards search
Find widgets whose queries cover a topic you care aboutcx dashboards query-search --description
Find widgets whose queries reference a specific field pathcx dashboards query-search --field
Browse all dashboardscx dashboards catalog

Examples

Find a dashboard for a service
cx dashboards search "payment service error rate"
cx dashboards search "kubernetes node cpu"
Find widgets whose queries cover a topic
cx dashboards query-search --description "http 5xx error rate"
cx dashboards query-search --description "p99 latency over time"
Find all widgets that reference a field
cx dashboards query-search --field '$d.http.status_code'
cx dashboards query-search --field '$d.kubernetes.pod.name'

This reveals query patterns already in use — useful for reusing existing approaches when adding new widgets.

Inspect and clone a found dashboard
# Get full JSON of a dashboard you found
cx dashboards get <dashboard-id> -o json > dashboard.json
# Modify it, then create a copy
cx dashboards create --from-file dashboard.json

Key Principles

  • Search before creating — always run cx dashboards search before building a new dashboard to avoid duplicates
  • Use field search for discovery — cx dashboards query-search --field shows how a field is already being queried, which is the fastest way to find reusable PromQL or DataPrime patterns
  • Description search is fuzzy — the results are ranked by similarity, not exact match; try several phrasings if the first search returns nothing useful
  • Use cx dashboards get to inspect — once you find a relevant dashboard or widget, pull its full JSON to study the query structure

Related Skills

  • cx-dashboards — build and deploy a new Coralogix dashboard from scratch
  • cx-telemetry-querying — discover what telemetry fields and metrics exist before searching dashboards

Comments

Markdown supported