Skip to main content
Glama
Sign In

AI Readiness Kit

by io.github.silverbackmarketing
OverviewDiscussionsAdmin

generate_ai_readiness_files

Start generating the 18 AI Readiness Kit files for a website. Returns the full workflow for the connected agent to execute (research, classify, write files).

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": "generate_ai_readiness_files"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlYesWebsite URL or domain, e.g. shopify.com or https://example.com

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.2/5.0
Behavior3/5

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

With no annotations, the description carries full burden. It reveals that the tool returns a workflow rather than directly creating files ('Returns the full workflow for the connected agent to execute'), which is a key behavioral trait. However, it does not disclose side effects, time involved, or whether the workflow is asynchronous.

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

Conciseness4/5

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

Single sentence covering purpose and behavior, with no filler. Could be split for readability but remains efficient.

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?

For a simple 1-param tool with no output schema, the description covers what it does and returns. However, it omits details like synchronous vs asynchronous nature, and whether the url must be fully qualified.

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 100% with a clear description for 'url'. The tool description adds no extra meaning beyond the schema, so baseline 3 applies.

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 clearly states the tool generates 18 AI Readiness Kit files for a website, using a specific verb 'generate' and resource 'files'. It also mentions returning a workflow, distinguishing it from siblings like get_file_spec which likely retrieves specs. However, it does not explicitly differentiate from generate_rag_jsonl.

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?

No guidance on when to use this tool vs alternatives (e.g., get_file_spec for single file specs). No prerequisites or exclusion criteria mentioned.

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

All AI Readiness Kit toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources