Skip to main content
Glama

Read the dashboard

dashboard_get
Read-onlyIdempotent

Retrieve a compact flat status snapshot in one call: balances, spending totals, open shopping, due chores, recent activity, announcements, and setup health. Use it for quick status checks.

Instructions

Returns the compact overall picture of the flat in one call: balances, spendByDay, spending totals in cents (per currency in totalSpendByCurrency, weekSpendByCurrency, monthSpendByCurrency), openShoppingCount, openShoppingTop, dueChores, activity, latestAnnouncement, myOpenAnnouncements, dueRecurringExpenses, absentMembers and wgHealth setup state. Use it for a quick status check; for full lists use the dedicated tools such as expenses_list, shopping_list or chores_list, and for the event history use activity_get. Read-only; limited to 60 reads per minute per member (error rate_limited).

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": "dashboard_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
wgCodeNoShare code of the flat (code from wg_list). Leave it out when the account belongs to one flat.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the readOnly/idempotent annotations, the description discloses a concrete throttling regime (60 reads per minute per member) and the resulting error identifier (rate_limited). It also tells the agent the call is a single aggregated read covering many domains, which explains why one request substitutes for several.

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 purpose and the tool-routing advice are front-loaded and the single-call aggregation plus rate limit are stated compactly. The long comma-delimited field enumeration is dense but earns its place by letting the agent decide whether the compact view is sufficient or a dedicated list tool is needed.

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?

There is no output schema, so the description must carry the return-value burden, and it does so by listing the payload sections it provides. With the single optional parameter fully documented in the schema and alternatives plus limits spelled out, nothing an agent needs in order to call it correctly is missing.

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%, and the schema already explains wgCode's pattern and the 'leave it out when the account belongs to one flat' fallback. The description adds nothing about the parameter, so the baseline 3 applies.

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 names a specific verb and resource ('Returns the compact overall picture of the flat in one call') and then enumerates the exact payload sections (balances, spending totals per currency, dueChores, wgHealth, etc.). That field list lets an agent tell it apart from narrower siblings like balances_get or expenses_list without opening either schema.

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

Usage Guidelines5/5

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

It states exactly when to use the tool ('quick status check'), when not to, and names the alternatives for the deeper cases (expenses_list, shopping_list, chores_list, activity_get). The routing is explicit rather than inferred.

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