beacon-mcp

get_dashboard

Retrieve beacon dashboard payload for a specified date range, including metrics, activity, traffic, and distribution breakdowns. Filter by project, model, user, or status, and optionally fetch specific sub-sections.

Instructions

Fetch the beacon dashboard payload (or a single sub-section) for the given date range. Returns metrics, activity, traffic, prompt/distribution breakdowns, and the top projects/sessions.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_dashboard"
  }
}

Input Schema

Name	Required	Description
`org`	No	Organization (tenant) ID. Omit to use the default org from $BEACON_ORG.
`from`	No	Start date inclusive (YYYY-MM-DD).
`to`	No	End date inclusive (YYYY-MM-DD).
`project`	No	Project name to filter by (exact match). Use 'all' to disable.
`model`	No	Model name to filter by (substring match). Use 'all' to disable.
`user`	No	User name or id to filter by (substring match). Accepts source_user_name or source_user_id.
`status`	No	Restrict to error or success events only.
`section`	No	Optional sub-module. Omit to fetch the full payload.

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Jun 13, 2026

TDQS

A3.8/5.0

Behavior3/5

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

With no annotations, the description carries the full burden. It explains the operation (fetch) and return content but does not disclose side effects, permissions, rate limits, or confirm it is read-only. Adequate but not detailed.

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?

Two concise sentences effectively convey the tool's purpose and output. No wasted words; front-loaded with the action and key parameters.

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

Completeness4/5

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

Given no output schema, the description helpfully enumerates the categories of data returned (metrics, activity, traffic, etc.). It covers the main aspects of the tool, though it could hint at the structure or size of the response.

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 coverage is 100%, so the description adds little beyond what the schema already provides. It mentions 'date range' and 'sub-section' which correspond to from/to and section parameters, but no additional semantic depth.

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 clearly states the tool fetches the beacon dashboard payload or a sub-section for a date range, listing the specific data components it returns. This distinguishes it from sibling tools like get_session_events or query_* tools which are more narrow in scope.

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

Usage Guidelines3/5

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

The description implies usage for fetching dashboard data but does not explicitly state when to use it versus alternatives, nor does it provide exclusions or prerequisites. The context is clear but lacks explicit guidance.

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

Deploy Server