Skip to main content
Glama
ayrank-tools

ayrank-tools

Official
by ay-automate

llms.txt generator

ayrank_llms_txt_generate
Read-only

Draft an llms.txt file from the company details you provide and receive a completeness score. Use the returned text to review LLM guidance before publishing; it neither reads nor writes to your site.

Instructions

Use to draft an llms.txt file from company details, with a completeness score. It returns text only and writes nothing to any site. It does not read the site, so it only knows what you pass in.

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": {
      "companyName": "<companyName>",
      "websiteUrl": "<websiteUrl>"
    },
    "name": "ayrank_llms_txt_generate"
  }
}

Input Schema

NameRequiredDescriptionDefault
industryNoIndustry, for example SaaS or Healthcare.
keyPagesNoKey page URLs, one per line.
servicesNoComma-separated list of services.
websiteUrlYesAbsolute http(s) URL of the site.
companyNameYesCompany name.
descriptionNoTwo or three sentences on what the company does.
socialLinksNoComma-separated social profile URLs.
contactEmailNoContact email.
differentiatorsNoWhat makes the company different, one per line.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior3/5

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

The annotations only declare readOnlyHint=true and openWorldHint=true, without covering the key behavioral questions. The description adds real value by stating that the output is text only, that the tool writes nothing to a site, and that it does not fetch or read the site, so the caller's input is the sole source. There is no tension with the annotations: openWorldHint describes the input domain, not network crawling.

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?

Three short sentences make up the description. The purpose comes first, then the output and write behavior, then the input constraint, so the most decision-relevant facts lead.

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 9-parameter, non-destructive generation tool with no output schema, the description covers what is produced (text plus a completeness score) and the main failure mode (it cannot read the site). The schema already documents the inputs, so an agent has everything needed to call it correctly.

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?

Every one of the 9 parameters already has a schema description, so 100% schema coverage, and the description adds no per-field meaning beyond that, such as the format of keyPages lines or how services feed into the score. The baseline of 3 is appropriate when the schema carries the parameter semantics.

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 uses a specific verb+resource: "draft an llms.txt file from company details, with a completeness score." That clearly distinguishes it from neighbors like ayrank_robots_txt_generate or ayrank_sitemap_validate, even though no sibling is named explicitly.

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?

The phrase "Use to draft" establishes the context of use, and the sentence "it only knows what you pass in" sets a concrete precondition: the caller must supply the company data. No explicit when-not guidance or named alternative is provided, which keeps it below a 5.

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