Skip to main content
Glama

audit_findability

Audits HTML for findability: validates head essentials, Open Graph, Twitter tags, JSON-LD validity, and checks canonical-to-og:url agreement.

Instructions

Audit a page HTML string for findability in depth (BEACON): head essentials, Open Graph, Twitter, JSON-LD validity, and the canonical-versus-og:url agreement invariant.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
htmlYes
Behavior3/5

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

With no annotations, the description carries the burden of behavioral disclosure. It details what the audit checks (head essentials, Open Graph, Twitter, JSON-LD, canonical agreement), which is useful, but it does not describe the return format, whether it is read-only, or any side effects. The agent cannot predict output structure or potential errors.

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?

The description is a single front-loaded sentence that states the primary purpose first, then lists specific audit dimensions. Every word adds value with no redundant phrases or unnecessary detail.

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?

The tool audits multiple complex aspects but has no output schema and only one parameter. The description enumerates the audit scope but omits any explanation of the output format, scoring, or return structure. For a tool with this complexity and no structured return definition, additional detail on the result is needed.

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

Parameters4/5

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

Schema coverage is 0%, so the description must compensate. It identifies the sole parameter as a 'page HTML string', which clarifies the expected content type and purpose. However, it does not specify whether the string must be a full document or fragment, nor any formatting constraints.

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 action (audit) on a specific resource (page HTML string) and enumerates exact audit dimensions (head essentials, Open Graph, Twitter, JSON-LD validity, canonical-og:url agreement). This clearly distinguishes it from sibling tools like generate_head or audit_surface.

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

Usage Guidelines2/5

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

The description implies use when you have an HTML string and need to assess findability, but it provides no explicit when-to-use or when-not-to-use guidance, nor does it mention alternatives like audit_surface or audit_delivery. The context for choosing this tool over siblings is absent.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Polymathie-Studio/ds4ai-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server