Copy as Markdown[Open in ChatGPT](https://chatgpt.com/?q=Read%20https%3A%2F%2Fcoralogix.com%2Fdocs%2Fuser-guides%2Fmcp-server%2Ftools%2Fdashboards.md%20and%20help%20me%20with%20my%20question%20about%20this%20Coralogix%20documentation%20page.)[Open in Claude](https://claude.ai/new?q=Read%20https%3A%2F%2Fcoralogix.com%2Fdocs%2Fuser-guides%2Fmcp-server%2Ftools%2Fdashboards.md%20and%20help%20me%20with%20my%20question%20about%20this%20Coralogix%20documentation%20page.)

# Dashboards

The MCP server can search your [Custom Dashboards](https://coralogix.com/docs/docs/user-guides/custom-dashboards/introduction/.md) 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[​](#search-dashboards "Direct link to 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:**

| Name    | Required | Type   | Description                                                                                                                            |
| ------- | -------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------- |
| `query` | Yes\*    | string | Natural-language description of the dashboard to find. Runs a semantic search across indexed dashboards. Mutually exclusive with `id`. |
| `id`    | Yes\*    | string | Exact Coralogix dashboard ID for direct retrieval. Mutually exclusive with `query`.                                                    |
| `limit` | No       | number | Maximum 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[​](#search-saved-dashboard-queries "Direct link to 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:**

| Name          | Required | Type   | Description                                                                                       |
| ------------- | -------- | ------ | ------------------------------------------------------------------------------------------------- |
| `search_type` | Yes      | enum   | `semantic` or `by_field`.                                                                         |
| `query_text`  | No       | string | Natural-language description of the query to find. Required when `search_type` is `semantic`.     |
| `field_path`  | No       | string | Exact field path to match, such as `metadata.service`. Required when `search_type` is `by_field`. |
| `limit`       | No       | number | Maximum number of results to return (1-100, default: 10).                                         |

## Example prompts[​](#example-prompts "Direct link to Example prompts")

### Find a dashboard[​](#find-a-dashboard "Direct link to Find a dashboard")

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

### Inspect a dashboard's queries[​](#inspect-a-dashboards-queries "Direct link to Inspect a dashboard's queries")

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

### Find queries by field[​](#find-queries-by-field "Direct link to Find queries by field")

```
Which saved dashboard queries reference the metadata.service field?
```

## Next steps[​](#next-steps "Direct link to Next steps")

Learn more about [Custom Dashboards](https://coralogix.com/docs/docs/user-guides/custom-dashboards/introduction/.md).