Skip to main content
Glama
novacrm-mcp

novacrm-mcp

novacrm_get_metrics

Retrieves NovaCRM store analytics: paid revenue, average ticket, orders by status, and client/product totals. Use detail to focus on revenue, orders, products, clients, inventory, or visits.

Instructions

Resumo analítico da loja: faturamento pago, ticket médio, pedidos por status, total de clientes e produtos.

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

Input Schema

NameRequiredDescriptionDefault
detailNoVisão detalhada opcional: revenue (faturamento), orders (pedidos por status), products (mais vendidos e estoque baixo), clients (top clientes por LTV), inventory (unidades totais e faltando), visits (acessos anônimos à loja pública)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.3.0

TDQS

B3.2/5.0
Behavior3/5

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

No annotations are provided, so the description carries the burden. It does disclose the aggregated content of the response (revenue, ticket médio, order counts by status), which implies a read-only, store-scoped operation, but it never states explicitly that it is read-only, whether the scope is a single store or the whole account, or whether there is any time-window default. Adequate but with clear disclosure gaps.

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?

One sentence, front-loaded with the scope (loja) followed by the enumerated metrics; no filler. It is slightly compressed to the point of omitting a verb and any usage clause, but nothing present is wasted.

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?

For a zero-required-parameter, single-enum tool with no output schema, the description usefully enumerates what the default response contains, which compensates for the missing output schema. The remaining gap is the absence of any statement about scoping or time range, which matters for interpreting the numbers.

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 100% and the single enum parameter is documented in detail in the schema, including what each of revenue/orders/products/clients/inventory/visits returns. The description adds nothing about the detail parameter, so this is the baseline 3 case where the schema does all the work.

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 names the resource (loja analytics summary) and enumerates the concrete metrics returned: faturamento pago, ticket médio, pedidos por status, total de clientes e produtos. That clearly separates it from the CRUD siblings like novacrm_list_orders or novacrm_list_clients. It is a noun phrase rather than a verb+resource statement, so it stops short of 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 Guidelines2/5

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

There is no guidance on when to call this versus alternatives. In particular, novacrm_inventory_alerts and novacrm_get_store_visits are siblings that overlap with the inventory and visits modes exposed by the detail enum, and the description never explains which to prefer. The detail parameter's role in selecting among views is left entirely to the schema.

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