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
* audit, move dep audit, publishing baselines moved to Node.js 24
* build, engine, moved to Node.js 22 minimum
* cli, Node.js version copy, pin server version to support older Node.js
* docs, references moved to Node.js 22
* package, min engine version, cleaned test scripts
* src, drop Node.js 20 reference
* e2e, cleaned Node.js 20 checks, left itSkip, envNodeVersion
BREAKING CHANGE: Minimum supported Node.js is now 22, previously 20.
MCP clients and integrations running Node.js 20 will fail to start
on `@latest`.
To migrate:
- Either upgrade Node.js to a minimum of 22 LTS.
- Or pin the server configuration to a Node.js 20-compatible release
See usage docs for pinned configuration examples.
Copy file name to clipboardExpand all lines: README.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ It is intended to be extensible to meet the needs of different teams and project
7
7
[Read more about our roadmap and how we've structured the server in our architecture docs](./docs/architecture.md).
8
8
9
9
## Requirements
10
-
-[Node.js 20+](https://nodejs.org/)
10
+
-[Node.js 22+](https://nodejs.org/)
11
11
- NPM (or equivalent package manager)
12
12
13
13
## Quick start
@@ -18,6 +18,8 @@ The PatternFly MCP Server supports multiple configurations; see the [usage docum
18
18
19
19
#### Set a basic MCP configuration
20
20
21
+
> Unable to update to the required Node.js version? [See pinned MCP configuration examples for earlier Node.js versions.](./docs/usage.md#pinned-mcp-package-version)
Copy file name to clipboardExpand all lines: docs/development.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -158,8 +158,7 @@ The documentation catalog `src/docs.json` pins remote resources to specific comm
158
158
159
159
#### Programmatic runtime requirements
160
160
161
-
-**Node.js 20+**: Required to run the core MCP server.
162
-
-**Node.js 22+**: Required for loading external tool plugins (`--tool`) and for developers working on advanced process isolation features.
161
+
-**Node.js 22+**: Required to run the MCP server, load external tool plugins (`--tool`), and use advanced process isolation features.
163
162
164
163
**Example: Programmatic test mode**
165
164
```typescript
@@ -411,7 +410,7 @@ These terms describe **how tools and their related properties are represented**
411
410
412
411
### Tool plugins
413
412
414
-
-**Plugins don't appear**: Verify the Node version (requires Node.js >= 20; >= 22 for tool plugins) and check logs (enable `--log-stderr`).
413
+
-**Plugins don't appear**: Verify the Node version (requires Node.js >= 22 for tool plugins) and check logs (enable `--log-stderr`).
415
414
-**Startup warnings/errors**: Startup `load:ack` warnings/errors from tool plugins are logged when stderr/protocol logging is enabled.
416
415
-**Schema errors**: If `tools/call` rejects with schema errors, ensure `inputSchema` is valid. See [Authoring tools](#authoring-tools) for details.
417
416
-**Network access issues**: If the tool is having network access issues, you may need to configure `--plugin-isolation none`. This is generally discouraged for security reasons but may be necessary in some cases.
@@ -424,7 +423,7 @@ These terms describe **how tools and their related properties are represented**
424
423
425
424
### General issues
426
425
427
-
-**Server won't start**: Check Node.js version (requires Node.js >= 20; >= 22 for tool plugins).
426
+
-**Server won't start**: Check Node.js version (requires Node.js >= 22 to run the server).
428
427
-**Missing tools/resources**: Verify the server started successfully and check logs with `--log-stderr`.
Copy file name to clipboardExpand all lines: docs/usage.md
+33-4Lines changed: 33 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -97,6 +97,33 @@ Access specific component documentation or technical specifications using the fo
97
97
98
98
Most MCP clients use JSON configuration to specify how the server is started. Below are examples you can adapt for your client.
99
99
100
+
### Pinned MCP package version
101
+
102
+
Depending on your environment, you may have to delay updating to the minimum Node.js version required by the server. If you are unable to upgrade your Node.js version and must remain on a previous Node.js version, you can pin your MCP configuration to the last compatible version of the server.
103
+
104
+
> **Note**: Currently, pinning to an older PatternFly MCP version means you will not receive updated documentation or new features until you "update" your pinned version. In the future, pinning a version may still make an allowance for documentation updates. [See our planned architecture.](./architecture.md#hybrid-documentation-in-progress)
105
+
106
+
#### When to choose `@latest` or a pinned version for configuration
107
+
108
+
| Node.js version | Package spec | Feature notes |
|**>=22**|`@patternfly/patternfly-mcp@latest`| Newest PatternFly features and rules. Includes **enhanced security isolation** for custom tool plugins. |
111
+
|**>=20**|`@patternfly/patternfly-mcp@1.1.0`| Standard features and rules. Lacks **custom tool plugins**; compatible with all default PatternFly configurations. |
"description": "PatternFly rules and documentation (Node.js 20 compatible)"
122
+
}
123
+
}
124
+
}
125
+
```
126
+
100
127
### Minimal client config (stdio)
101
128
102
129
```json
@@ -182,14 +209,16 @@ These are **first-step checks** for common setup problems, not full diagnostics.
182
209
183
210
> **Agents**: PatternFly MCP server information is available internally through the `patternfly://context` MCP resource.
184
211
185
-
### 1. Verify Node.js Version
186
-
The PatternFly MCP server requires **Node.js 20 or higher**.
212
+
### 1. Verify Node.js version
213
+
The PatternFly MCP server requires **Node.js 22 or higher**.
187
214
188
215
-**How to check**:
189
216
-**macOS/Linux**: Open **Terminal** and type `node -v`.
190
217
-**Windows**: Open **PowerShell** or **Command Prompt** and type `node -v`.
191
-
-**Requirement**: You should see a version starting with `v20`, `v22`, or higher.
192
-
-**Solution**: If your version is lower than 20, please download and install the latest "LTS" (Long Term Support) version from [nodejs.org](https://nodejs.org/).
218
+
-**Requirement**: You should see a version starting with `v22`, or higher.
219
+
-**Solution**: If your version is lower than 22, please download and install the latest "LTS" (Long Term Support) version from [nodejs.org](https://nodejs.org/).
220
+
221
+
> **Unable to update your Node.js version?**[See pinned configuration examples for earlier Node.js versions.](#pinned-mcp-package-version)
193
222
194
223
### 2. Reset the npx Cache
195
224
If you encounter an `ERR_MODULE_NOT_FOUND` error or don't see the latest features, your system may be using a "stale" or corrupted version in its cache.
-**Guidance Review Scope**: Unless the user explicitly asks, do not make recommendations on improving guidance if all you're asked to do is review guidance.
48
-
-**Environment Awareness**:
48
+
-**Environment Awareness**:
49
49
- Server and plugin execution requirements are defined in `package.json`.
50
50
- Always verify environment compatibility by checking `patternfly://context` or `package.json`.
51
51
- Proactively check for environment mismatches (e.g., Node.js version) if tools fail to load.
0 commit comments