Skip to main content
Glama

Read Site Health

read_site_health
Read-onlyIdempotent

Site Health scores, coverage and top issues for the latest crawl, or a chosen snapshot_id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYes
snapshot_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered without the description. The description adds the default-resolution behavior (latest crawl when no snapshot is given), which is genuine context beyond the annotations, but says nothing about response shape or limits.

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?

A single compressed sentence with the resource and payload front-loaded and no filler. It is slightly telegraphic as a noun phrase rather than a full clause, but nothing is wasted.

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

Completeness3/5

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

For a two-parameter, read-only tool with no output schema, the description covers the core scope and default behavior adequately. It leaves gaps around the sibling render_site_health relationship and what the returned 'top issues' actually contain.

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 0%, so the description must carry parameter meaning. It clarifies that snapshot_id selects a specific snapshot versus defaulting to the latest crawl, but says nothing about project_id (the required parameter) or the UUID format expectations.

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 (read) and resource (Site Health) and names the concrete payload: scores, coverage, and top issues. It does not differentiate itself from the sibling render_site_health, so an agent must guess at the read-vs-render split.

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?

The phrase 'for the latest crawl, or a chosen snapshot_id' implies the two usage modes (default to newest, or target a specific snapshot), which is useful conditional guidance. However, it never states when to prefer this over render_site_health or the other read_* visibility tools, so alternatives are left to inference.

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