Skip to main content
Glama
ayrank-tools

ayrank-tools

Official
by ay-automate

IndexNow key check

ayrank_indexnow_key_check
Read-only

Verify that an IndexNow key file is live and matches the provided key before submitting URLs, without sending anything to IndexNow.

Instructions

Use to check that an IndexNow key file is live and matches the key (step 1 of IndexNow). Nothing is sent to IndexNow. To submit URLs after it passes, use ayrank_indexnow_submit.

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": {
      "host": "<host>",
      "key": "<key>"
    },
    "name": "ayrank_indexnow_key_check"
  }
}

Input Schema

NameRequiredDescriptionDefault
keyYesThe IndexNow key, 8 to 128 characters of a-z, A-Z, 0-9 and dashes.
hostYesThe host, like www.example.com. A URL is accepted and its host is used.
keyLocationNoThe key file URL when it is not at the root, on the same host.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

The annotations already declare readOnlyHint=true and openWorldHint=true; the description adds useful context beyond them by clarifying that nothing is actually sent to IndexNow, i.e. this is a fetch/verification step rather than a submission. It does not say what happens if the key is missing or mismatched (error vs. negative result), which leaves a small gap.

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?

Two short sentences with no filler; the purpose and scope are front-loaded and the pointer to the sibling comes last. Every sentence carries information.

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 three-parameter read-only check with full schema coverage and no output schema, the definition covers purpose, safety and sequencing well. The only missing element is a hint about the shape of the result (pass/fail or mismatch detail), which an agent would otherwise have to discover by calling it.

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 100%, so host, key and keyLocation are already fully documented in the schema. The description adds no parameter-level meaning beyond that, so the baseline of 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 states a specific verb and resource ('check that an IndexNow key file is live and matches the key') and labels the tool's place in the workflow as step 1 of IndexNow. An agent can easily distinguish it from the sibling submit tool.

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

Usage Guidelines5/5

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

It explicitly states when to use it (pre-submission verification), names the follow-up alternative 'ayrank_indexnow_submit', and gives the condition for moving on: 'after it passes'. This is close to ideal guidance.

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