Skip to main content
Glama

Request Usage-By-Agent Report

lyzr_report_usage_by_agent

Request an async usage report grouped by agent, receiving a job ID to poll for completion and retrieve results.

Instructions

Request an async usage report broken down by agent. 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.
agent_typeNoFilter by agent type
created_byNouser_id to filter agents by creator
start_dateNoStart date (YYYY-MM-DD), required when timeframe is 'custom'
include_sub_orgsNoWhen true, include agents from the current org AND all its sub-orgs
Behavior4/5

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

Annotations indicate readOnlyHint=false and idempotentHint=false, and the description adds valuable context that the operation is asynchronous and returns a job_id that requires polling. This tells the agent that invoking this tool will create a background job rather than returning immediate results, which is behavioral information beyond the annotation flags.

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?

The description is two sentences long, front-loaded with the core purpose, and contains no redundant or irrelevant information. Every word earns its place, making it highly efficient for an agent to parse.

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 an async request tool with a comprehensive schema and annotations, the description covers the essential workflow: making the request, receiving a job_id, and polling for status. It does not explain the contents of the report, but that is not necessary given the schema and the existence of lyzr_report_get_status.

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% for all 8 parameters, including details about timeframes, date formats, and grouping options. The description text itself contributes no parameter-specific semantics beyond what the schema already documents, so the baseline score of 3 is appropriate.

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 uses a specific verb ('Request'), object ('an async usage report'), and grouping ('broken down by agent'), distinguishing it from sibling usage report tools by its agent-level focus. It also clearly communicates the async nature and the next step (polling), making the tool's purpose immediately understandable.

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?

The description explicitly states the async workflow: request, get job_id, poll with lyzr_report_get_status. This provides clear context for how to use the tool. However, it does not directly mention alternatives (e.g., usage_by_model, usage_by_sub_account) or exclusion criteria, though the tool name and phrase 'by agent' imply when it should be used.

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