Get dashboard summary
get_dashboard_summaryGet aggregated dashboard statistics: total assets, work orders by status, overdue count, active PM schedules, sites, and buildings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
get_dashboard_summaryGet aggregated dashboard statistics: total assets, work orders by status, overdue count, active PM schedules, sites, and buildings.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, non-destructive, and closed-world behavior. The description adds that the result is aggregated statistics and lists the main categories, but does not explain time range, scope, freshness, or return structure beyond those labels.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence with no wasted words. It states the resource and then efficiently enumerates the returned aggregate categories.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description effectively lists the metrics returned, which is the most important missing structured detail. It still lacks time-range and scope context, but for a zero-parameter read-only summary tool this is largely sufficient.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters and the schema is empty at 100% coverage, so there are no parameter semantics to clarify. The description appropriately does not invent or omit parameter details.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb ('Get') and resource ('dashboard summary'), and enumerates the aggregate metrics returned. It is clear what the tool does, but it does not distinguish itself from sibling tools such as get_dashboard_snapshot or list_dashboard_snapshots.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives no when-to-use guidance, no prerequisites, and no alternatives. An agent must infer that this is for a dashboard overview, with no help choosing between it and the related dashboard snapshot tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.