You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: guidelines/skills/add-docs-links/SKILL.md
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,9 @@ description: Maintains the PatternFly MCP documentation catalog in src/docs.json
7
7
8
8
## When to use
9
9
10
-
User wants to **add**, **change**, or **remove** rows in `src/docs.json`, or fix broken / unreachable catalog links. They may paste **any GitHub URL** (blob or raw); you convert blob → raw, pick refs, verify reachability, shape entries, update `meta` and `generated`, and run tests.
10
+
- User wants to **add**, **change**, or **remove** rows in `src/docs.json`, or fix broken / unreachable catalog links
11
+
- User provides a GitHub URL (blob or raw) to register in the catalog — convert blob → raw, pick refs, verify reachability, shape entries, update `meta` and `generated`, and run tests
12
+
- User asks to update or fix `docs.json` entries, contribute to the docs catalog, or align with docs.json tests and CI audit
11
13
12
14
For **edits or removals**: find the row by `path` and/or its `docs` key; update `meta` / `generated`; run tests. Same rules as adds: whitelist, unique `path`, and `src/__tests__/docs.json.test.ts` (including `baseHashes`).
13
15
@@ -20,7 +22,7 @@ For **edits or removals**: find the row by `path` and/or its `docs` key; update
20
22
- New ref for an existing repo: resolve SHA (e.g. commits API) or use a stable tag.
21
23
22
24
2.**Whitelist**
23
-
-`path` must match `patternflyOptions.urlWhitelist` in `src/options.defaults.ts`. See [reference.md](reference.md#url-whitelist-allowed-domains). Use **https** only. Do not widen the whitelist in a catalog-only PR.
25
+
-`path` must match `patternflyOptions.urlWhitelist` in `src/options.defaults.ts`. See [reference.md — URL whitelist](reference.md#url-whitelist-allowed-domains). Use **https** only. Do not widen the whitelist in a catalog-only PR.
24
26
25
27
3.**Reachability**
26
28
- Response must be 2xx (e.g. `curl -sI -o /dev/null -w "%{http_code}" "<url>"`). If not, fix ref or path; do not add a dead link.
@@ -47,6 +49,10 @@ For **edits or removals**: find the row by `path` and/or its `docs` key; update
47
49
48
50
**CI:**`.github/workflows/audit.yml` on PRs that touch `src/docs.json` or `tests/audit/**`.
49
51
52
+
## Additional resources
53
+
54
+
-[reference.md](reference.md) — entry format, top-level structure, URL whitelist, duplicate check, ref lookup, unit test constraints, example entry
55
+
50
56
## Quick checks
51
57
52
58
-[ ] Blob → raw; ref reused per repo when possible.
Copy file name to clipboardExpand all lines: guidelines/skills/review-zod-integration/SKILL.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
name: review-zod-integration
3
-
description: Reviews Zod dependency upgrades for PatternFly MCP—maps release notes to codebase usage, runs tests, and writes a dated update report with impact tables and prioritized fixes. Use when bumping zod, reviewing zodintegration, assessing Zod breaking changes, generating a zod update report, or reviewing Dependabot/Renovate zod PRs.
3
+
description: Reviews Zod dependency upgrades for PatternFly MCP—maps release notes to codebase usage, runs tests, and writes a dated update report with impact tables and prioritized fixes. Use when bumping zod, on review zod, zod upgrade, zod integration review, assessing Zod breaking changes, generating a zod update report, or reviewing Dependabot/Renovate zod PRs.
4
4
---
5
5
6
6
# Review Zod Integration (PatternFly MCP)
@@ -62,6 +62,10 @@ description: Reviews Zod dependency upgrades for PatternFly MCP—maps release n
@@ -70,7 +70,7 @@ If release notes only mention these, impact is usually **None**:
70
70
|`zod`| Direct production dep; use native `fromJSONSchema` / `toJSONSchema` (not `zod-to-json-schema` in app code) |
71
71
|`@modelcontextprotocol/sdk`| Depends on / peers `zod ^3.25 \|\| ^4.0`|
72
72
73
-
## Audit Depth Policy
73
+
## Audit depth policy
74
74
75
75
| Source | Frequency | Objective |
76
76
| :--- | :--- | :--- |
@@ -271,19 +271,19 @@ No release-note item maps to APIs used in PF MCP hot paths; unit, e2e, and audit
271
271
272
272
## Architecture
273
273
274
-
### SDK Routing Trigger
274
+
### SDK routing trigger
275
275
The MCP SDK requires `inputSchema` to be a Zod instance to route `(args, context)` to tool handlers. We rehydrate minimal Zod in the parent process (via `normalizeInputSchema`) specifically to trigger this signature, while keeping genuine validation in the isolated child process.
276
276
277
-
## Compatibility Policy (Zod Detection)
277
+
## Compatibility policy (Zod detection)
278
278
279
279
To support a diverse plugin ecosystem, PatternFly MCP maintains a "Compatibility-First" approach for Zod schema detection.
280
280
281
-
### Preservation Rules:
281
+
### Preservation rules
282
282
1.**Never Remove `_def` Detection**: Even when pinned to Zod 4+, the `isZodSchema` function in `src/server.schema.ts` must keep the `_def` check to support plugins using Zod v3.
283
283
2.**Additive Detection**: When Zod introduces new public APIs (like `.def` in v4.4), add detection for them *alongside* existing internal brands (`_zod`, `_def`).
284
284
3.**Exceptions**: Legacy detection should only be removed if the Zod release notes indicate that a legacy property (e.g., `_def`) has been repurposed in a way that causes false positives or crashes in the current version.
285
285
286
-
### Updated P2 Recommendations (Recurring):
286
+
### Updated P2 recommendations (recurring)
287
287
These items MUST be included in the "Recommended Fixes (P2)" section of the report for any Zod 4.4+ review to ensure long-term health, even if they are not strictly required for the current bump to "pass."
288
288
289
289
-**DO**: Add detection for the public `.def` property (Zod 4.4+).
0 commit comments