Skip to main content
Glama

Get Dashboard Getlistingsummary

hgr_get_dashboard_getlistingsummary
Read-onlyIdempotent

Dedicated HGRApi tool for GET api/Dashboard/GetListingSummary. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Returns an aggregate summary of published products, recent products and average price for the current channel. ownerAgent: account-metrics. Domain: listings. Entity: listing_summary. Operation: aggregate. Scope: current_store. Use when: Use it for dashboard views or aggregate metrics for the selected channel. Input: Header channel: current ChannelOAuthId. Does not use concrete listing ids. Output: Returns listing counters and aggregates. Search terms: dashboard getlistingsummary. Requires HGRApi Header channel / ChannelOAuthId resolved internally.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "channelOAuthId": "<channelOAuthId>"
    },
    "name": "hgr_get_dashboard_getlistingsummary"
  }
}

Input Schema

NameRequiredDescriptionDefault
channelOAuthIdYesChannelOAuthId returned by hgr_list_channels for the selected visible store.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, open-world, so the safety profile is covered. The description adds scope (current_store) and a note that the channel is resolved from the ChannelOAuthId, but it also says the header channel is 'resolved internally' while the schema makes channelOAuthId a required input, which muddies rather than clarifies runtime behavior.

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

Conciseness3/5

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

The purpose and usage are front-loaded after several sentences of boilerplate ('Dedicated HGRApi tool for GET api/...', 'This is an explicit tool with a fixed endpoint'). A redundant 'Search terms: dashboard getlistingsummary' line repeats the tool name and earns little.

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?

With one required parameter, full schema documentation, an output schema, and safety annotations, the description supplies the remaining context an agent needs: data scope, when to use it, and what kind of aggregates it returns. Only the channel-resolution ambiguity slightly weakens completeness.

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 parameter description already explains that channelOAuthId comes from hgr_list_channels. The description only restates that the header channel is the current ChannelOAuthId and adds that concrete listing ids are not used — marginal added meaning, so the baseline 3 applies.

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 states a specific verb+resource: returns an aggregate summary of published products, recent products, and average price for the current channel. It also names the domain/entity/operation (listings, listing_summary, aggregate), which separates it from list-oriented siblings like hgr_get_active_listings. The useful content is somewhat buried under endpoint boilerplate, which keeps it from a 5.

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?

It gives an explicit 'Use when' clause (dashboard views or aggregate metrics for the selected channel) and an exclusion ('Does not use concrete listing ids'), which steers the agent away from id-specific tools. It does not name a concrete alternative sibling, so it falls short of a 5.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources