Skip to main content
Glama

searchconsole.sitemaps.get

Retrieves details for a specific sitemap in a Search Console site by site URL and sitemap URL, returning the sitemap metadata as JSON.

Instructions

Retrieves information about a specific sitemap [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, list, submit.

Input Schema

NameRequiredDescriptionDefault
queryNoExtra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
paramsNoParameter map merged into the request; typed parameters win.
dry_runNoReturn the request that would be sent, without sending it.
siteUrlYes[URL path segment] The site's URL, including protocol. For example: `http://www.example.com/`.
feedpathYes[URL path segment] The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters.

Output Schema

NameRequiredDescriptionDefault
pathNo
typeNo
errorsNo
contentsNo
warningsNo
isPendingNo
lastSubmittedNo
lastDownloadedNo
isSitemapsIndexNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / feedpath / description
      Previous value: -"The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`."New value: +"[URL path segment] The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`."
    • changedInput schema / properties / siteUrl / description
      Previous value: -"The site's URL, including protocol. For example: `http://www.example.com/`."New value: +"[URL path segment] The site's URL, including protocol. For example: `http://www.example.com/`."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "contents": {
      +      "items": {
      +        "properties": {
      +          "indexed": {
      +            "type": "string"
      +          },
      +          "submitted": {
      +            "type": "string"
      +          },
      +          "type": {
      +            "enum": [
      +              "WEB",
      +              "IMAGE",
      +              "VIDEO",
      +              "NEWS",
      +              "MOBILE",
      +              "ANDROID_APP",
      +              "PATTERN",
      +              "IOS_APP",
      +              "DATA_FEED_ELEMENT"
      +            ],
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "errors": {
      +      "type": "string"
      +    },
      +    "isPending": {
      +      "type": "boolean"
      +    },
      +    "isSitemapsIndex": {
      +      "type": "boolean"
      +    },
      +    "lastDownloaded": {
      +      "type": "string"
      +    },
      +    "lastSubmitted": {
      +      "type": "string"
      +    },
      +    "path": {
      +      "type": "string"
      +    },
      +    "type": {
      +      "enum": [
      +        "NOT_SITEMAP",
      +        "URL_LIST",
      +        "SITEMAP",
      +        "RSS_FEED",
      +        "ATOM_FEED",
      +        "PATTERN_SITEMAP",
      +        "OCEANFRONT"
      +      ],
      +      "type": "string"
      +    },
      +    "warnings": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observed

TDQS

A3.9/5.0
Behavior3/5

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

With no annotations, the description carries the behavioral burden and does disclose that this is an HTTP GET returning JSON, implying a safe read. But it also includes generic request-body construction language that is irrelevant for a GET and does not mention permissions, error behavior, or any other operational constraints.

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 is front-loaded and the sibling reference is concise. However, the middle clause about building request bodies from typed parameters or body_file is unnecessary noise for an HTTP GET sitemap retrieval.

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?

The tool has a full input schema, an output schema, and a description that identifies the exact resource and sibling operations. It is mostly complete, though for a tool with no annotations it could say more about authentication or permission requirements.

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 the schema already documents every parameter, including siteUrl, feedpath, params, query, dry_run, and body_file. The description merely restates generic behavior about typed parameters winning over the params map, adding little semantic value 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?

The description states a specific verb and resource: retrieves information about a specific sitemap. It also explicitly names the sibling operations over the same resource (delete, list, submit), making it easy to distinguish retrieval of one sitemap from listing or mutating sitemaps.

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 sibling tools are named, which gives useful context that this is the single-sitemap read operation versus delete, list, or submit. However, it does not explicitly state when to choose this tool over searchconsole.sitemaps.list or any prerequisites for using it.

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

Deploy Server

Other Tools