Skip to main content
Glama

audit_sitemap

Read-onlyIdempotent

Audit up to 10 pages listed in a sitemap or sitemap index. Returns one summary line per page plus the full report of every page with findings. Needs an API key.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "sitemap_url": "<sitemap_url>"
    },
    "name": "audit_sitemap"
  }
}

Input Schema

NameRequiredDescriptionDefault
languageNoReport language as a code such as en, de, fr, es, ja or zh. Defaults to the account language (English without a key); 30 languages are supported.
max_urlsNoHow many page URLs from the sitemap to audit, 1 to 10.
sitemap_urlYesURL of a sitemap.xml or sitemap index, for example https://example.com/sitemap.xml.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedInput schema / properties / language / description
      Added value: +"Report language as a code such as en, de, fr, es, ja or zh. Defaults to the account language (English without a key); 30 languages are supported."
    • addedInput schema / properties / max_urls / description
      Added value: +"How many page URLs from the sitemap to audit, 1 to 10."
    • addedInput schema / properties / max_urls / minimum
      Added value: +1
    • addedInput schema / properties / sitemap_url / description
      Added value: +"URL of a sitemap.xml or sitemap index, for example https://example.com/sitemap.xml."
  2. First observed

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so safety is covered. The description contributes two real facts beyond that: the shape of the response (one summary line per page plus full per-page reports) and that an API key is required. It says nothing about rate limits, throttling, or what happens when a sitemap exceeds the cap.

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?

Three short sentences, zero waste: purpose first, return shape second, auth requirement last. Nothing is repeated or padded.

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?

An output schema exists, so return values need not be explained further, and annotations carry the safety profile. Combined with a fully documented 3-parameter schema, the description supplies what is missing: scope ceiling, index support, and the API key requirement.

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 language, max_urls and sitemap_url are already documented in the schema. The description echoes the 10-page ceiling already encoded in max_urls' default and maximum, adding no new parameter meaning. Baseline 3 is appropriate.

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?

States a specific verb and resource: audit pages listed in a sitemap or sitemap index. The scope ('up to 10 pages', 'sitemap index' support) implicitly separates it from single-page auditing, though it never names the sibling it differs from.

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

Usage Guidelines3/5

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

Usage is implied by the resource ('sitemap or sitemap index') rather than stated as guidance. There is no explicit when-to-use versus audit_url, and no exclusions or prerequisites beyond the API key note.

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.