Skip to main content
Glama

Zyte MCP Server

zyte_api_usage_stats

Recorded Zyte API usage of the organization: requests made, cost, response times and status codes for a time window (default: the last 7 days), as one summary or broken down with group_by into one row per hour/day/month/year, per target domain (sorted by cost), per requested feature (browserHtml, httpResponseBody, screenshot, actions, ...) or per automatic extraction type (product, article, ...). Filter by domain, API key label, status code, feature, extraction type or request tags ('tag:value'). Costs are in the currency's main unit (e.g. USD), one entry per currency. Only recorded usage: it cannot estimate a future crawl (use zyte_api_domain_pricing for rates) and knows nothing about Scrapy Cloud jobs. Rate limit: 20 Stats API calls per minute; group_by 'feature' spends 8 of them and 'extraction_type' 11, so do not repeat those within a minute.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tagsNoOnly requests carrying all of these tags; each entry is 'tag' or 'tag:value'.
domainsNoOnly requests to these domains.
featureNoOnly requests that used this feature.
end_timeNoEnd of the window, UTC, same formats. A bare date is included whole. Default: now.
group_byNo'none' for one total; 'hour'/'day'/'month'/'year' for one row per time bucket; 'domain' for one row per target domain; 'feature' or 'extraction_type' for one row per Zyte API feature or automatic extraction type used.none
start_timeNoStart of the window, UTC, as an ISO 8601 date (2026-08-01) or date-time (2026-08-01T12:00:00Z). Default: 7 days ago.
status_codesNoOnly requests that got these HTTP status codes.
domain_healthNoAdd Zyte's health status per domain (top 100 domains of the last 7 days). Implies group_by=domain.
api_key_labelsNoOnly requests made with API keys having these labels.
organizationIdYesRequired. The Zyte organization whose usage to report: the number in https://app.zyte.com/o/<id>, the 'organizationId' of a Scrapy Cloud project, or one of the organizations the user_info tool lists. Never guess an id; once chosen, reuse it across the session unless the user asks for another.
extraction_fromNoOnly extraction requests from this source.
extraction_typeNoOnly requests with this automatic extraction type.

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A4.8/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and does so well: it discloses the 20 calls/minute rate limit, that group_by 'feature' spends 8 and 'extraction_type' 11 of those, that costs are in the currency's main unit with one entry per currency, the default 7-day window, and that only recorded usage is covered. This is unusually rich behavioral context for a read tool.

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?

The purpose and grouping/filter capabilities are front-loaded in the first sentence, followed by limitations and rate limits. It is dense and reads as two very long sentences, which slightly hurts scanability, but essentially every clause carries operational information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 12-parameter analytics tool with no output schema, the description covers the window, grouping modes, filter dimensions, currency semantics, limitations, and rate-limit cost of expensive group_by values. The row-per-bucket semantics are also spelled out in the schema, so nothing an agent needs to call it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning beyond it: the expected 'tag:value' filter syntax, that domain grouping is sorted by cost, and the conceptual mapping of each filter dimension. It stops short of explaining defaults for every filter, keeping it at 4.

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?

States a specific verb+resource ('Recorded Zyte API usage of the organization') and enumerates the exact metrics returned (requests, cost, response times, status codes). It explicitly distinguishes itself from siblings by naming zyte_api_domain_pricing and ruling out Scrapy Cloud jobs, so an agent can route without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

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

Gives explicit when-to-use (historical usage over a time window with grouping/filtering) and when-not ('cannot estimate a future crawl – use zyte_api_domain_pricing'; 'knows nothing about Scrapy Cloud jobs'). It also warns not to repeat expensive group_by calls within a minute, which is actionable routing guidance.

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