readiness-audit 2.5.0 → 2.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/README.md +1 -1
- package/STANDARD.md +4 -1
- package/package.json +1 -1
- package/src/audit.mjs +2 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 2.6.0 (2026-11-04)
|
|
4
|
+
|
|
5
|
+
From two projects fixing their APIs: one has no `/v1` prefix. No scoring changes, and no new warnings or failures.
|
|
6
|
+
|
|
7
|
+
- **A12 Don't break saved calls** (recommended, checked in review). Agents save calls in scripts and skills and rerun them without rereading the docs, so a breaking change goes in a new version, the old one keeps working for a stated time, and the changelog that llms.txt links says so. A `/v1` prefix isn't needed before the first breaking change. The scorecard lists A12 among the items to check yourself.
|
|
8
|
+
|
|
3
9
|
## 2.5.0 (2026-11-03)
|
|
4
10
|
|
|
5
11
|
From a project's agent that was asked why llms-full.txt should hold a site's whole text. D4 said "the whole corpus" without saying what that meant, and the scorecard only checked that the file existed. One new warning, no new failures: a site whose llms-full.txt leaves out pages llms.txt links now warns in D4, which lowers its required score until fixed but doesn't change the exit code.
|
package/README.md
CHANGED
|
@@ -15,7 +15,7 @@ npx readiness-audit example.com
|
|
|
15
15
|
It needs Node 22.23.4, 24.22.1 or 26.12.1, or later on the same line (each supported line's current security release), and has no dependencies.
|
|
16
16
|
|
|
17
17
|
```
|
|
18
|
-
Agent and search readiness: animalhouse.ai (readiness-audit v2.
|
|
18
|
+
Agent and search readiness: animalhouse.ai (readiness-audit v2.6.0, 2026-11-04T22:14Z)
|
|
19
19
|
|
|
20
20
|
Required
|
|
21
21
|
PASS D1 robots.txt 1 group with consistent rules, Sitemap listed
|
package/STANDARD.md
CHANGED
|
@@ -95,7 +95,7 @@ What it means:
|
|
|
95
95
|
|
|
96
96
|
| If your project... | Serve | Skip |
|
|
97
97
|
|---|---|---|
|
|
98
|
-
| has a public HTTP API | A1 to A11: OpenAPI 3.1, `GET /api`, errors that teach, a JSON catch-all for wrong paths, forgiving input; A3 to A5 as recommended | |
|
|
98
|
+
| has a public HTTP API | A1 to A11: OpenAPI 3.1, `GET /api`, errors that teach, a JSON catch-all for wrong paths, forgiving input; A3 to A5 and A12 as recommended | |
|
|
99
99
|
| ships an MCP server on npm (stdio) | M1 to M3: npm, the MCP Registry, Smithery, Glama, a `/docs/mcp` page | server card, `/.well-known/mcp.json`, OAuth metadata: they describe a hosted endpoint |
|
|
100
100
|
| hosts an MCP endpoint | M1 to M4: everything above plus the forgiving edge, `remotes` in `server.json`, and a DNS AID record with `p=mcp`; M5, the server card, as recommended | |
|
|
101
101
|
| runs an A2A endpoint | a valid A2A v1.0 agent card | |
|
|
@@ -250,6 +250,8 @@ Each item says what it is, why it's at its level, and how you know it's done. Se
|
|
|
250
250
|
|
|
251
251
|
**A5 The API reference as raw markdown** at `/docs/api.md` (inbed, drifts, botsmatter). Agents don't want the HTML.
|
|
252
252
|
|
|
253
|
+
**A12 Don't break saved calls.** *Why: agents save calls in scripts and skills and rerun them without rereading the docs.* Make a breaking change in a new version, keep the old one working for a stated time, and say so in the changelog that llms.txt links. A `/v1` prefix isn't needed before then: unprefixed paths are version 1 until the first breaking change.
|
|
254
|
+
|
|
253
255
|
**S2 Agent Skills discovery index** at `/.well-known/agent-skills/index.json`, following Cloudflare's discovery RFC v0.2.0:
|
|
254
256
|
|
|
255
257
|
| Field | Required value |
|
|
@@ -863,6 +865,7 @@ Level: **R** required where it applies, **Rec** recommended, **N** next level. W
|
|
|
863
865
|
| A9 | `Retry-After` on 429, a usage endpoint, documented limits | R | agents | review |
|
|
864
866
|
| A10 | Self-service keys, rotation, attribution | R | agents | review |
|
|
865
867
|
| A11 | Public and private stated honestly, one privacy filter, citations that open | R | honesty | review, test |
|
|
868
|
+
| A12 | Breaking changes in a new version, the old one kept for a stated time | Rec | agents | review |
|
|
866
869
|
| M1 | MCP tools: thin, generated, described, annotated, errors as results, prompts | R | agents | score (hosted), test |
|
|
867
870
|
| M2 | Stdio package: saved key, register guard, rotate, User-Agent, mcpName | R | agents | review, test |
|
|
868
871
|
| M3 | Published to npm, the MCP Registry, Smithery and Glama, one version | R | discovery | test |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "readiness-audit",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.6.0",
|
|
4
4
|
"description": "Score a site's readiness for AI agents and search (GEO, AEO, AI SEO): llms.txt, robots.txt AI crawler rules, structured data, link previews, OpenAPI, MCP, agent skills and A2A. Read-only CLI, no account.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
package/src/audit.mjs
CHANGED
|
@@ -11,7 +11,7 @@ import { isIP } from 'node:net';
|
|
|
11
11
|
import { request } from './http.mjs';
|
|
12
12
|
import { SKILL_NAME, sampleSkillEntries, skillNameProblem, cdnCacheNote, repeatsSummary, hasVariantDescription, spread, samplePages, sharedCardText, API_LINK, MCP_LINK, linkRels, apiPresence, DISCOVERY_FILES, AI_BOTS, missingSections, richResultPages, list, norm, pathDepth, decodeText, headings, headingSkips, sitemapEntries, llmsLinks, baseMapper, formatRecorded } from './helpers.mjs';
|
|
13
13
|
|
|
14
|
-
export const VERSION = '2.
|
|
14
|
+
export const VERSION = '2.6.0';
|
|
15
15
|
export const REPO = 'https://github.com/geeks-accelerator/agent-and-search-readiness';
|
|
16
16
|
const UA = `readiness-audit/${VERSION} (+${REPO})`;
|
|
17
17
|
const AID_PROTOCOLS = ['mcp', 'a2a', 'openapi', 'grpc', 'graphql', 'websocket', 'local', 'zeroconf', 'ucp'];
|
|
@@ -33,6 +33,7 @@ export const REVIEW = [
|
|
|
33
33
|
['A9', 'Retry-After on 429, documented limits'],
|
|
34
34
|
['A10', 'self-service keys, rotation, attribution'],
|
|
35
35
|
['A11', 'public and private stated honestly, one privacy filter'],
|
|
36
|
+
['A12', 'breaking changes in a new version, the old one kept for a stated time'],
|
|
36
37
|
['M2', 'stdio package: saved key, register guard, rotate, User-Agent'],
|
|
37
38
|
['M3', 'published to npm, the MCP Registry, Smithery and Glama, one version'],
|
|
38
39
|
['S1', 'skills: triggers name the job, lasting actions say what they do, and an agent can follow them through the core loop on its own (the scorecard checks names, descriptions and links on a sample)'],
|