Skip to content

Commit ec85b89

Browse files
committed
fix: refine
1 parent 739d80d commit ec85b89

4 files changed

Lines changed: 20 additions & 10 deletions

File tree

guidelines/skills/add-docs-links/SKILL.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ description: Maintains the PatternFly MCP documentation catalog in src/docs.json
77

88
## When to use
99

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
1113

1214
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`).
1315

@@ -20,7 +22,7 @@ For **edits or removals**: find the row by `path` and/or its `docs` key; update
2022
- New ref for an existing repo: resolve SHA (e.g. commits API) or use a stable tag.
2123

2224
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.
2426

2527
3. **Reachability**
2628
- 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
4749

4850
**CI:** `.github/workflows/audit.yml` on PRs that touch `src/docs.json` or `tests/audit/**`.
4951

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+
5056
## Quick checks
5157

5258
- [ ] Blob → raw; ref reused per repo when possible.

guidelines/skills/add-docs-links/reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# docs.json Reference
1+
# Add docs links — Reference (PatternFly MCP)
22

33
## File location
44

guidelines/skills/review-zod-integration/SKILL.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
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 zod integration, 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.
44
---
55

66
# Review Zod Integration (PatternFly MCP)
@@ -62,6 +62,10 @@ description: Reviews Zod dependency upgrades for PatternFly MCP—maps release n
6262

6363
Domain context (SDK routing, schema pipeline, peer range): [reference.md — Quick PF MCP facts](reference.md#quick-pf-mcp-facts).
6464

65+
## Additional resources
66+
67+
- [reference.md](reference.md) — grep patterns, key files, priority rules, compatibility policy, report template, example impact rows, architecture notes
68+
6569
## Quick checks
6670

6771
- [ ] Versions (from → to) and release notes captured (or offline limitation noted)

guidelines/skills/review-zod-integration/reference.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Review Zod Integration — Reference (PatternFly MCP)
1+
# Review Zod integration — Reference (PatternFly MCP)
22

33
## Quick PF MCP facts
44

@@ -70,7 +70,7 @@ If release notes only mention these, impact is usually **None**:
7070
| `zod` | Direct production dep; use native `fromJSONSchema` / `toJSONSchema` (not `zod-to-json-schema` in app code) |
7171
| `@modelcontextprotocol/sdk` | Depends on / peers `zod ^3.25 \|\| ^4.0` |
7272

73-
## Audit Depth Policy
73+
## Audit depth policy
7474

7575
| Source | Frequency | Objective |
7676
| :--- | :--- | :--- |
@@ -271,19 +271,19 @@ No release-note item maps to APIs used in PF MCP hot paths; unit, e2e, and audit
271271

272272
## Architecture
273273

274-
### SDK Routing Trigger
274+
### SDK routing trigger
275275
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.
276276

277-
## Compatibility Policy (Zod Detection)
277+
## Compatibility policy (Zod detection)
278278

279279
To support a diverse plugin ecosystem, PatternFly MCP maintains a "Compatibility-First" approach for Zod schema detection.
280280

281-
### Preservation Rules:
281+
### Preservation rules
282282
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.
283283
2. **Additive Detection**: When Zod introduces new public APIs (like `.def` in v4.4), add detection for them *alongside* existing internal brands (`_zod`, `_def`).
284284
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.
285285

286-
### Updated P2 Recommendations (Recurring):
286+
### Updated P2 recommendations (recurring)
287287
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."
288288

289289
- **DO**: Add detection for the public `.def` property (Zod 4.4+).

0 commit comments

Comments
 (0)