Skip to main content
Glama

By subdomain and folder

breakdown_by_path
Read-onlyIdempotent

Groups the property's pages by host (subdomain) and by the first depth path segments (1–4), e.g. "example.com/blog/*": pages per group, clicks, impressions, ctr, position, clickShare, comparison (prevClicks, clicksChange, clicksChangePct, positionChange) and the top 3 pages of each group. Sorted by clicks. Use for "which section drives traffic", "is the blog growing", "how is the /pt/ folder doing" and to compare subdomains. / Tráfego por subdomínio e pasta (profundidade 1–4).

Input Schema

NameRequiredDescriptionDefault
daysNoWindow length in days (default 28). Ignored when startDate and endDate are both given. / Janela em dias.
siteYesProperty: displayName ("example.com"), Search Console siteUrl ("sc-domain:example.com", "https://www.example.com/") or numeric id. A unique substring among visible properties also works ("exam"). list_sites shows the options. / Propriedade por nome, siteUrl ou id.
brandNoall (default); branded = only queries containing one of the property's branded_terms; non-branded = the rest. Needs branded terms set on the property in the Organiq panel, otherwise invalid_argument with the panel URL. / Marca × sem marca.
depthNoPath depth (default 1: first folder).
limitNoGroups (default 50).
queryNoOnly queries containing this text, or a regex as /…/ (e.g. "/^how to/"; no flag = case-insensitive).
deviceNoDevice.
compareNoComparison: previous (default) = same-length window immediately before; year = same dates one year earlier; none. / Comparação.
countryNoCountry as ISO-3166-1 alpha-3, as in Search Console: bra, usa, prt, arg.
endDateNoEnd yyyy-mm-dd. Default: last synced date of the property (Search Console lags ~3 days; never "today"). Every response states the period used. / Fim; padrão = última data sincronizada.
minClicksNoHide groups with fewer clicks than this in both periods (default 0).
startDateNoStart yyyy-mm-dd. Default: endDate − (days − 1).
searchTypeNoSearch type (default web).
pageContainsNoOnly pages whose URL contains this text (case-insensitive), e.g. "/blog/".

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), and the description adds substantive behavior: the exact returned metrics (clicks, impressions, ctr, position, clickShare, prevClicks/clicksChange/positionChange) and the top-3-pages-per-group cap plus clicks-based sorting. With no output schema, this is the only place an agent learns the response shape; only the deliberate omission of pagination/truncation details keeps it from 5.

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 front-loaded sentence carries the grouping rule, the output contents and the use cases, then a short example list. It is somewhat dense with a long parenthetical metric enumeration, and the bilingual Portuguese tail adds little for an English agent, but nothing is genuinely wasteful.

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 14-parameter, output-schema-less tool, the description supplies the return-field inventory and grouping semantics that structured fields do not, and annotations handle safety. Remaining gaps are minor: no mention of how groups are truncated beyond `limit` and no note on host normalization (www vs. subdomain).

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%, so all 14 parameters are already documented in structured fields, which sets the baseline at 3. The description only reinforces `depth` slightly by tying it to the "example.com/blog/*" example; it adds no other parameter meaning beyond the schema.

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 the specific verb (groups), the resource (property's pages) and the exact grouping key (host plus first `depth` path segments), with a concrete example key like "example.com/blog/*". This is clearly distinguishable from get_breakdown and query_top_pages, which are ungrouped/other-dimension listings.

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?

Gives concrete triggering questions ("which section drives traffic", "is the blog growing", "how is the /pt/ folder doing") and states it is for comparing subdomains, so the agent knows when to reach for it. It never explicitly names an alternative (e.g. get_breakdown) or a when-not condition, so it stops short of 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.