Skip to main content
Glama

Request Usage-By-Model Report

lyzr_report_usage_by_model

Request an asynchronous usage report broken down by model, receive a job ID, and poll with lyzr_report_get_status for results.

Instructions

Request an async usage report broken down by model. Returns a job_id; poll with lyzr_report_get_status.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modelNoFilter by model name
end_dateNoEnd date (YYYY-MM-DD), required when timeframe is 'custom'
group_byNoOptional row-splitting dimension: 'month' splits by calendar month, 'billing_cycle' splits by the org's subscription cycle. Omit for a single aggregated row per entity.
timeframeYesTimeframe preset for the report window. Use 'custom' with start_date/end_date.
start_dateNoStart date (YYYY-MM-DD), required when timeframe is 'custom'
provider_idNoFilter by LLM provider id
include_sub_orgsNoWhen true, include usage from the current org AND all its sub-orgs
Behavior4/5

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

Discloses the async nature and the need to poll with a separate tool, which is critical behavioral context beyond the annotations. Annotations (readOnlyHint=false, idempotentHint=false) are consistent with this description, and no contradiction exists.

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 well-structured sentences deliver the core action and follow-up step without any fluff. Front-loaded and efficient.

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?

Covers the essential async request flow and directs the user to the polling tool. With the schema fully documenting parameters, the description is sufficient; mentioning the report's exact content beyond 'by model' is not necessary given the name and schema.

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%, with detailed descriptions for all 7 parameters, so the description does not need to repeat them. The description adds no additional parameter semantics beyond the tool's overall purpose.

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 action ('Request'), the resource ('async usage report broken down by model'), and the key behavior (returns a job_id, poll with lyzr_report_get_status). It effectively distinguishes from sibling report tools by explicitly targeting usage by model.

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 provides clear context on when to use this tool (when a usage-by-model report is needed) and the required follow-up workflow (polling). It does not explicitly name alternatives or exclusions, but the guidance is unambiguous.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/nandanNM/lyzr-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server