Skip to main content
Glama
ayrank-tools

ayrank-tools

Official
by ay-automate

Heading outline

ayrank_heading_outline
Read-only

List a page's h1–h6 headings in order with levels, announced text, and landmarks, while flagging missing h1s, skipped levels, and empty or image-only headings.

Instructions

Use to list a page's h1 to h6 headings in order with level, announced text and landmark, and flag no h1, skipped levels, empty or image-only headings. More than one h1 is a note only. Not a content quality score. Free AY Rank API, no key. JavaScript is not run, so content added by scripts is not seen.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "url": "<url>"
    },
    "name": "ayrank_heading_outline"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlYesThe page to check, like https://example.com/page.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds genuinely useful operating context the annotations do not carry: the API is free and needs no key, and JavaScript is not executed so script-injected content is invisible. It does not describe output shape or pagination, but with only one URL there is little more to disclose; a 3 reflects solid but not exceptional added context.

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 purpose and scope come first, followed by compact caveats about interpretation, cost, and JavaScript. Every clause contributes something actionable and there is no filler.

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

Completeness5/5

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

For a one-parameter read tool with no output schema, the description fully compensates by describing the returned fields and the flags the agent should expect. Combined with the JavaScript caveat and the no-key note, an agent has everything needed to call it and interpret the result.

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 required parameter whose schema description already covers it at 100%, so semantic burden is minimal. The description says nothing extra about the url argument such as protocol or redirect handling, so the baseline 3 applies.

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 names a specific verb and resource ('list a page's h1 to h6 headings in order') and enumerates the returned fields (level, announced text, landmark) plus the defect flags (no h1, skipped levels, empty or image-only headings). That is enough to separate it from siblings like ayrank_alt_text or ayrank_title_score without opening a schema.

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?

It sets clear boundaries: 'Not a content quality score' and 'More than one h1 is a note only' tell the agent how to interpret results rather than treat them as ranking signals. It does not name a specific alternative sibling to use instead, so it falls short of a full when/when-not routing statement.

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