get_sitemap

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

No annotations are provided. The description discloses that it returns 'index status and errors' but does not mention side effects (likely none), permissions, or rate limits. It provides moderate transparency for a read operation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is very concise: a single purpose sentence followed by parameter documentation. Every sentence adds value, and the structure is front-loaded. No unnecessary words.

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

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

The description is largely complete for a simple getter tool with two parameters and no output schema. It explains what is returned and provides parameter examples. It does not cover error scenarios or permissions, but given the tool's simplicity, it is nearly complete.

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

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

Schema coverage is 0%, but the description adds meaningful details: site_url example 'sc-domain:example.com' and feedpath example 'https://example.com/sitemap.xml'. This clarifies the expected format and adds value beyond the schema's property names.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool 'Returns details for a single sitemap, including index status and errors.' The verb 'Returns' and resource 'single sitemap' are specific. It distinguishes from the sibling list_sitemaps which lists multiple sitemaps.

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

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

Usage context is implied but not explicitly stated. The description assumes the user has a specific sitemap URL. No guidance on when to use this tool versus alternatives like inspect_url or list_sitemaps, nor any prerequisites or exclusions.

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