Skip to main content
Glama

Agentic Web Wiki — standards reference, probe, validate, template

template

Read-onlyIdempotent

Spec-compliant boilerplate for an agent-facing file, filled with your domain: ard (and ai-catalog-well-known-file), llms-txt, agents-md, mcp-server-cards (SEP-2127), a2a (agent card 1.0), ai-crawler-tokens-robots, api-catalog-rfc9727, security-txt, auth-md. Input: id; optional domain, name, description, mcp_url, api_url, agent_url, contact. Returns target_path, content_type, recommended_headers, contents, the fields to edit, notes on the specification, and the validate_manifest call to run once it is live.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesone of ard, ai-catalog-well-known-file, llms-txt, agents-md, mcp-server-cards, a2a, ai-crawler-tokens-robots, api-catalog-rfc9727, security-txt, auth-md
nameNo
domainNobare hostname the file is for, e.g. example.com (default example.com)
api_urlNoabsolute https URL of the OpenAPI description
contactNomailto:, https: or tel: URI (a bare email gets mailto:)
mcp_urlNoabsolute https URL of the MCP endpoint
agent_urlNoabsolute https URL of the A2A endpoint
descriptionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • addedInput schema / properties / agent_url / description
      Added value: +"absolute https URL of the A2A endpoint"
    • addedInput schema / properties / api_url / description
      Added value: +"absolute https URL of the OpenAPI description"
    • addedInput schema / properties / contact / description
      Added value: +"mailto:, https: or tel: URI (a bare email gets mailto:)"
    • addedInput schema / properties / domain / description
      Added value: +"bare hostname the file is for, e.g. example.com (default example.com)"
    • addedInput schema / properties / mcp_url / description
      Added value: +"absolute https URL of the MCP endpoint"
  2. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds value by enumerating the concrete return fields (target_path, content_type, recommended_headers, contents, fields to edit, notes, validate_manifest call), but does not explain behavior like whether the boilerplate is static or templated from the supplied inputs, or how missing optional fields are handled.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The long enumeration of ten spec IDs plus an eight-item return-field list makes the description dense and somewhat hard to scan. Information is front-loaded reasonably (purpose first, then inputs, then returns), but the run-on structure could be tightened without losing meaning.

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?

With no output schema, the description compensates by enumerating the return fields and noting the follow-up validate_manifest call. For a read-only, idempotent boilerplate tool the coverage is strong; the only gap is behavior when optional inputs are omitted or how template filling works.

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 coverage is 75% and descriptions exist for id, domain, api_url, contact, mcp_url, agent_url. The description lists the parameters by name (id required; domain, name, description, mcp_url, api_url, agent_url, contact optional) but adds little semantic detail beyond the schema. It does clarify that name/description are optional, but the heavy lifting is already in the schema.

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?

States a specific resource: spec-compliant boilerplate for an agent-facing file, listing the supported spec IDs explicitly. The verb is less crisp (does it generate, return, or scaffold the file?), but the resource and enumeration are clear enough to distinguish it from siblings like validate_manifest or get.

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

Usage Guidelines3/5

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

The description implies use when you need starter content for one of the listed specs, and it explicitly notes running validate_manifest once live. However, it does not state when NOT to use it or contrast with siblings, so guidance remains implied rather than explicit.

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.