Skip to main content
Glama
okareo-ai

Okareo MCP Server

Official
by okareo-ai

Save Dashboard

save_dashboard
Idempotent

Create or update an analytics dashboard by name, with customizable panels for charts and tables, using automatic layout sizing and time range selection.

Instructions

Create or update an analytics dashboard by name (upsert).

    If a dashboard with this name already exists it is updated; otherwise a
    new one is created.

    Size each panel with a named ``size`` from the catalog below (PREFERRED
    — guarantees a legible layout) and omit positions entirely: panels are
    auto-placed in the order given (left-to-right, top-to-bottom on a
    12-column grid, wrapping rows, never overlapping).

    Size catalog and when to use each:

    - ``small-square`` (3x6): single ``stat`` metrics.
    - ``half-rectangle`` (6x6): ``line``/``bar``/``area`` trends, two per row.
    - ``half-square`` (6x9): ``radar``, ``composed``, denser charts.
    - ``full-rectangle`` (12x9): wide time-series comparisons.
    - ``full-square`` (12x12): ``table`` panels.

    Args:
        name: Dashboard name — the upsert key.
        panels: Optional list of panel definitions. Each panel is an object:

            - ``title`` (str, required): panel heading.
            - ``chart_type`` (str, required): one of ``line``, ``bar``,
              ``composed``, ``area``, ``radar``, ``stat``, ``table``.
            - ``query`` (object, required): what to chart —
              ``{"cube": "check_trend", "measures": [...],
              "dimensions": [...], "filters": [...],
              "time_dimensions": [...], "order": {...}}``. ``measures`` is
              required; everything else is optional. ``cube`` defaults to
              ``check_trend``. The dashboard ``time_range`` applies to all
              panels — panels do NOT carry their own time range.
            - ``size`` (str): a catalog name (see above). Required unless
              ``layout`` is given; wins over ``layout`` w/h if both appear.
            - ``layout`` (object): raw grid placement
              ``{"x": >=0, "y": >=0, "w": >=1, "h": >=1}`` (integers).
              Only needed when not using ``size``, or to pin an explicit
              position (give both ``x`` and ``y``; with ``size``, w/h are
              ignored). Heights below the legibility floor are sized up on
              save: ``h >= 6`` when ``w <= 6``, ``h >= 9`` when ``w > 6``.
            - ``table_config`` (object, optional): ONLY for
              ``chart_type == "table"``.

            ``check_trend`` measures: ``avg_check_value``, ``issue_rate``,
            ``error_rate``, ``datapoint_count``, ``issue_count``,
            ``error_count``, ``test_run_count``, ``avg_latency``,
            ``sum_cost``, ``input_token_count``, ``output_token_count``.
            ``check_trend`` dimensions: ``check.name``, ``check.id``,
            ``target.name``, ``target.id``, ``scenario.name``,
            ``scenario.id``, ``test_run.id``, ``test_run.type``,
            ``test_run.is_latest_for_target``, ``source``, ``provider``,
            ``request_model_name``, ``response_model_name``, ``tag``.
            Use ``query_analytics(include_metadata=True)`` for the
            authoritative, current set.

            Example panel::

                {"title": "Avg Check Value by Check", "chart_type": "bar",
                 "query": {"measures": ["avg_check_value"],
                           "dimensions": ["check.name"]},
                 "size": "half-rectangle"}
        description: Optional dashboard description.
        time_range: Optional default look-back window for the whole
            dashboard. One of: LAST_HOUR, LAST_24_HOURS, LAST_7_DAYS,
            LAST_14_DAYS, LAST_30_DAYS, LAST_90_DAYS. Defaults to
            LAST_90_DAYS when omitted.

    Returns:
        JSON with the saved dashboard and ``action`` (created/updated).
        When sizing or dimensions were changed on save (size overriding
        layout w/h, or a height floored), an ``adjustments`` list reports
        each change: ``{"panel", "field", "from", "to", "reason"}``.
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
panelsNo
time_rangeNo
descriptionNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the annotations (idempotentHint=true, destructiveHint=false), the description details many behavioral traits: upsert behavior, auto-placement of panels, size overriding layout w/h, height flooring adjustments, and the return of an 'adjustments' list. This adds substantial context beyond what annotations provide.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is long but well-structured with clear sections, bullet points, and an example. Every sentence adds value, though it could be slightly tightened. The front-loaded first sentence states the core purpose immediately.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity and the sparse schema, the description is exhaustive: it explains return values (including 'action' and 'adjustments'), defaults (time_range defaults to LAST_90_DAYS), the query object, and how to get authoritative dimensions/measures. It fully compensates for the lack of schema descriptions.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema is extremely sparse (0% coverage), so the description carries the full burden. It thoroughly explains each parameter: name, panels (with full panel object structure including title, chart_type, query, size, layout, table_config), time_range allowed values, and description. It also enumerates measures/dimensions and provides an example.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with 'Create or update an analytics dashboard by name (upsert)', which uses a specific verb ('create or update'), identifies the resource ('analytics dashboard'), and highlights the upsert behavior. This clearly distinguishes it from siblings like get_dashboard, list_dashboards, and delete_dashboard.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear guidance on when to use the tool (upsert semantics) and internal usage guidelines such as the size catalog and when to use size vs. layout. However, it does not explicitly contrast with sibling tools (e.g., 'use get_dashboard to view rather than save'), though the purpose statement implies it.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/okareo-ai/okareo-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server