Skip to main content
Glama

Run a health check

run_health_check

Run a schema health check for a saved location: validates its markup, scans its website for the embed and conflicting hard-coded schema, detects unpublished changes and records the result in the dashboard and client reports. Needs a LocalSchema Pro API key in the request headers.

Input Schema

NameRequiredDescriptionDefault
location_idYesLocation id from list_locations

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already flag readOnlyHint=false, openWorldHint=true, and destructiveHint=false; the description adds real value beyond them by disclosing the write side effects (records the result in the dashboard and client reports), the external network scan of the customer website, and the API-key auth requirement. It leaves out duration, rate limits, and failure/partial-result behavior.

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?

Two sentences, front-loaded with the purpose and followed by the prerequisite. The enumerated capabilities are dense but each clause adds distinct information; the auth requirement is appended where it is easy to miss before invocation.

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 one-parameter tool with no output schema but full annotation coverage, the description supplies what an agent needs: what is checked, that it persists results to dashboard/reports, that it reaches the open web, and that an API key header is required. Only the expected result/report shape is left implicit.

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?

There is a single parameter with 100% schema description coverage ('Location id from list_locations'), so the schema already carries parameter meaning. The description only says the check is 'for a saved location' and adds no format or sourcing detail beyond that, so baseline 3 applies.

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?

The description states a specific verb (run a health check) on a specific resource (a saved location's schema) and enumerates the concrete sub-actions: markup validation, website embed scan, hard-coded schema conflict detection, and unpublished-change detection. It is far more specific than validate_schema or validate_page, though it never explicitly names those siblings as alternatives.

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?

Clear context is given: this operates on a saved location (implying list_locations/get_location as the setup step) and requires a LocalSchema Pro API key in the request headers. It does not state when to prefer this over validate_schema or validate_page, which is the only missing guidance.

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