Skip to main content

Dashboards

The MCP server can search your Custom Dashboards and the queries saved inside them. Use these tools to find a dashboard by meaning or by ID, and to locate saved queries by description or by the field they reference.

These read-only tools are available on MCP server v2 and use the permissions of your authenticated user, so you need read access to Custom Dashboards (TEAM-DASHBOARDS:READ).

Search dashboards

Use the search_dashboard tool to find dashboards by semantic search, or to retrieve a single dashboard by its exact ID. Provide either query or id, but not both. When you pass id, the tool returns that dashboard's saved metadata, including its widgets, queries, variables, filters, and field paths.

Parameters:

NameRequiredTypeDescription
queryYes*stringNatural-language description of the dashboard to find. Runs a semantic search across indexed dashboards. Mutually exclusive with id.
idYes*stringExact Coralogix dashboard ID for direct retrieval. Mutually exclusive with query.
limitNonumberMaximum number of search results when using query (1-100, default: 10). Ignored when you provide id.

* Provide either query or id, but not both.

Search saved dashboard queries

Use the search_queries tool to find queries saved in dashboards, either by meaning or by the field they reference. Set search_type to select the mode:

  • semantic — semantic search over saved queries. Requires query_text.
  • by_field — find saved queries that reference a specific field path. Requires field_path.

Parameters:

NameRequiredTypeDescription
search_typeYesenumsemantic or by_field.
query_textNostringNatural-language description of the query to find. Required when search_type is semantic.
field_pathNostringExact field path to match, such as metadata.service. Required when search_type is by_field.
limitNonumberMaximum number of results to return (1-100, default: 10).

Example prompts

Find a dashboard

Find the dashboard that tracks checkout-service latency and error rate.

Inspect a dashboard's queries

Show me the widgets and queries saved in dashboard <dashboard-id>.

Find queries by field

Which saved dashboard queries reference the metadata.service field?

Next steps

Learn more about Custom Dashboards.

Last updated on