Skip to main content
Glama
alilxxey

openobserve-community-mcp

get_dashboard

Retrieve dashboard definitions by ID from OpenObserve Community Edition to access and analyze monitoring data visualizations.

Instructions

Get a dashboard definition by id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dashboard_idYes
include_rawNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The get_dashboard tool registration and handler implementation. It uses the OpenObserveClient to fetch the dashboard and then transforms the output using build_get_dashboard_result.
    @server.tool()
    def get_dashboard(dashboard_id: str, include_raw: bool = False) -> dict[str, Any]:
        """Get a dashboard definition by id."""
        client = client_provider.get()
        raw = client.get_dashboard(dashboard_id=dashboard_id)
        return build_get_dashboard_result(
            org_id=client.resolve_org_id(),
            dashboard_id=dashboard_id,
            raw=raw,
            include_raw=include_raw,
        )
Behavior2/5

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

No annotations are provided, so the description carries full burden. It states 'Get a dashboard definition', implying a read-only operation, but doesn't disclose behavioral traits like authentication needs, rate limits, error handling, or what 'definition' entails. The description is minimal and lacks necessary context for safe invocation.

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

Conciseness5/5

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

The description is a single, efficient sentence with zero waste. It's front-loaded and appropriately sized for the tool's simple purpose, making it easy to parse quickly.

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

Completeness3/5

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

Given the tool's low complexity (2 parameters, no nested objects) and the presence of an output schema, the description is minimally adequate. However, with no annotations and 0% schema coverage, it lacks details on behavior and parameters that would improve completeness for a read operation.

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

Parameters3/5

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

Schema description coverage is 0%, so the schema provides no parameter descriptions. The description mentions 'by id', which hints at the 'dashboard_id' parameter, but doesn't explain the 'include_raw' parameter or add meaning beyond the basic schema. With 2 parameters and low coverage, this is a baseline score as it partially compensates.

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

Purpose4/5

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

The description clearly states the verb 'Get' and resource 'dashboard definition by id', making the purpose understandable. It doesn't distinguish from siblings like 'list_dashboards' or 'search_around', but the core action is specific enough for a read operation.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives like 'list_dashboards' or 'search_around'. The description implies it's for retrieving a specific dashboard by ID, but lacks explicit context or prerequisites for usage.

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/alilxxey/openobserve-community-mcp'

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