list_dashboards
Retrieve dashboard listings from OpenObserve Community Edition to monitor and analyze organizational data visualizations.
Instructions
List dashboards in the current organization.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| folder | No | ||
| title | No | ||
| page_size | No | ||
| include_raw | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- The low-level API client method that performs the actual network request to list dashboards.
def list_dashboards( self, *, folder: str | None = None, title: str | None = None, page_size: int | None = None, ) -> Any: query: dict[str, str | int | float | bool] = {} if folder: query["folder"] = folder if title: query["title"] = title if page_size is not None: query["pageSize"] = page_size return self.request_json( "GET", self._org_path("/api/{org_id}/dashboards"), query=query or None, ) - openobserve_mcp/server.py:192-205 (handler)The MCP tool handler function that calls the client and formats the response using the build_list_dashboards_result helper.
def list_dashboards( folder: str | None = None, title: str | None = None, page_size: int | None = None, include_raw: bool = False, ) -> dict[str, Any]: """List dashboards in the current organization.""" client = client_provider.get() raw = client.list_dashboards(folder=folder, title=title, page_size=page_size) return build_list_dashboards_result( org_id=client.resolve_org_id(), raw=raw, include_raw=include_raw, )