Skip to content

Commit 3000fb5

Browse files
authored
build: move to patternfly branding (#2)
* package author, version reset, license file * readme, patternfly package references * test snapshot version scrub
1 parent e085648 commit 3000fb5

File tree

7 files changed

+53
-32
lines changed

7 files changed

+53
-32
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Red Hat, Inc.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@ npm run start:dev
4545
### Use via npx (after publishing)
4646

4747
```bash
48-
npx @jephilli-patternfly-docs/mcp
48+
npx @patternfly/patternfly-mcp
4949
```
5050

5151
Or install locally in a project and run:
5252

5353
```bash
54-
npm install @jephilli-patternfly-docs/mcp
55-
npx @jephilli-patternfly-docs/mcp
54+
npm install @patternfly/patternfly-mcp
55+
npx @patternfly/patternfly-mcp
5656
```
5757

5858
## Scripts
@@ -111,7 +111,7 @@ If you run the server with --docs-host, local paths you pass in urlList are reso
111111
Example:
112112

113113
```bash
114-
npx @jephilli-patternfly-docs/mcp --docs-host
114+
npx @patternfly/patternfly-mcp --docs-host
115115
```
116116

117117
Then, passing a local path such as react-core/6.0.0/llms.txt in urlList will load from llms-files/react-core/6.0.0/llms.txt.
@@ -127,7 +127,7 @@ Most MCP clients use a JSON configuration that tells the client how to start thi
127127
"mcpServers": {
128128
"patternfly-docs": {
129129
"command": "npx",
130-
"args": ["-y", "@jephilli-patternfly-docs/mcp@latest"],
130+
"args": ["-y", "@patternfly/patternfly-mcp@latest"],
131131
"description": "PatternFly React development rules and documentation"
132132
}
133133
}
@@ -141,7 +141,7 @@ Most MCP clients use a JSON configuration that tells the client how to start thi
141141
"mcpServers": {
142142
"patternfly-docs": {
143143
"command": "npx",
144-
"args": ["-y", "@jephilli-patternfly-docs/mcp@latest", "--docs-host"],
144+
"args": ["-y", "@patternfly/patternfly-mcp@latest", "--docs-host"],
145145
"description": "PatternFly docs (docs-host mode)"
146146
}
147147
}
@@ -207,10 +207,10 @@ Example (ESM):
207207

208208
```js
209209
// Prefer the public export subpath
210-
import { runServer } from '@jephilli-patternfly-docs/mcp/server';
210+
import { runServer } from '@patternfly/patternfly-mcp/server';
211211

212212
// Or from the package root (index.ts re-exports it)
213-
import { runServer } from '@jephilli-patternfly-docs/mcp';
213+
import { runServer } from '@patternfly/patternfly-mcp';
214214

215215
// Starts the MCP server and listens on stdio
216216
await runServer();
@@ -247,7 +247,7 @@ npm publish
247247

248248
After publishing, users can run your MCP server with:
249249
```bash
250-
npx @jephilli-patternfly-docs/mcp
250+
npx @patternfly/patternfly-mcp
251251
```
252252

253253
## Contributing

package-lock.json

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "@jephilli-patternfly-docs/mcp",
3-
"version": "1.1.0",
2+
"name": "@patternfly/patternfly-mcp",
3+
"version": "0.0.0",
44
"description": "PatternFly documentation MCP server built with Node.js and TypeScript",
55
"main": "dist/index.js",
66
"type": "module",
@@ -44,7 +44,7 @@
4444
"documentation",
4545
"react"
4646
],
47-
"author": "Jeff Phillips",
47+
"author": "Red Hat",
4848
"license": "MIT",
4949
"dependencies": {
5050
"@modelcontextprotocol/sdk": "1.19.1",
@@ -70,11 +70,11 @@
7070
},
7171
"repository": {
7272
"type": "git",
73-
"url": "git+https://github.com/jeff-phillips-18/patternfly-mcp.git"
73+
"url": "git+https://github.com/patternfly/patternfly-mcp.git"
7474
},
7575
"types": "./dist/index.d.ts",
7676
"bugs": {
77-
"url": "https://github.com/jeff-phillips-18/patternfly-mcp/issues"
77+
"url": "https://github.com/patternfly/patternfly-mcp/issues"
7878
},
79-
"homepage": "https://github.com/jeff-phillips-18/patternfly-mcp#readme"
79+
"homepage": "https://github.com/patternfly/patternfly-mcp#readme"
8080
}

src/__tests__/__snapshots__/options.test.ts.snap

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ exports[`freezeOptions should return frozen options with consistent properties:
66
"docsHost": true,
77
"docsPath": "/documentation",
88
"llmsFilesPath": "/llms-files",
9-
"name": "@jephilli-patternfly-docs/mcp",
9+
"name": "@patternfly/patternfly-mcp",
1010
"pfExternal": "https://raw.githubusercontent.com/patternfly/patternfly-org/refs/heads/main/packages/documentation-site/patternfly-docs/content",
1111
"pfExternalAccessibility": "https://raw.githubusercontent.com/patternfly/patternfly-org/refs/heads/main/packages/documentation-site/patternfly-docs/content/accessibility",
1212
"pfExternalCharts": "https://raw.githubusercontent.com/patternfly/patternfly-react/refs/heads/main/packages/react-charts/src",
@@ -46,7 +46,7 @@ exports[`freezeOptions should return frozen options with consistent properties:
4646
},
4747
},
4848
"urlRegex": /\\^\\(https\\?:\\)\\\\/\\\\//i,
49-
"version": "1.1.0",
49+
"version": "0.0.0",
5050
}
5151
`;
5252

@@ -61,7 +61,7 @@ exports[`options should return specific properties 1`] = `
6161
"contextPath": "/",
6262
"docsPath": "/documentation",
6363
"llmsFilesPath": "/llms-files",
64-
"name": "@jephilli-patternfly-docs/mcp",
64+
"name": "@patternfly/patternfly-mcp",
6565
"pfExternal": "https://raw.githubusercontent.com/patternfly/patternfly-org/refs/heads/main/packages/documentation-site/patternfly-docs/content",
6666
"pfExternalAccessibility": "https://raw.githubusercontent.com/patternfly/patternfly-org/refs/heads/main/packages/documentation-site/patternfly-docs/content/accessibility",
6767
"pfExternalCharts": "https://raw.githubusercontent.com/patternfly/patternfly-react/refs/heads/main/packages/react-charts/src",
@@ -101,7 +101,7 @@ exports[`options should return specific properties 1`] = `
101101
},
102102
},
103103
"urlRegex": /\\^\\(https\\?:\\)\\\\/\\\\//i,
104-
"version": "1.1.0",
104+
"version": "0.0.0",
105105
},
106106
"PF_EXTERNAL": "https://raw.githubusercontent.com/patternfly/patternfly-org/refs/heads/main/packages/documentation-site/patternfly-docs/content",
107107
"PF_EXTERNAL_ACCESSIBILITY": "https://raw.githubusercontent.com/patternfly/patternfly-org/refs/heads/main/packages/documentation-site/patternfly-docs/content/accessibility",

src/__tests__/__snapshots__/server.test.ts.snap

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ exports[`runServer should attempt to run server, create transport, connect, and
1111
"mcpServer": [
1212
[
1313
{
14-
"name": "@jephilli-patternfly-docs/mcp",
15-
"version": "1.1.0",
14+
"name": "@patternfly/patternfly-mcp",
15+
"version": "0.0.0",
1616
},
1717
{
1818
"capabilities": {
@@ -40,8 +40,8 @@ exports[`runServer should attempt to run server, register a tool: console 1`] =
4040
"mcpServer": [
4141
[
4242
{
43-
"name": "@jephilli-patternfly-docs/mcp",
44-
"version": "1.1.0",
43+
"name": "@patternfly/patternfly-mcp",
44+
"version": "0.0.0",
4545
},
4646
{
4747
"capabilities": {
@@ -81,8 +81,8 @@ exports[`runServer should attempt to run server, register multiple tools: consol
8181
"mcpServer": [
8282
[
8383
{
84-
"name": "@jephilli-patternfly-docs/mcp",
85-
"version": "1.1.0",
84+
"name": "@patternfly/patternfly-mcp",
85+
"version": "0.0.0",
8686
},
8787
{
8888
"capabilities": {
@@ -155,8 +155,8 @@ exports[`runServer should attempt to run server, use default tools: console 1`]
155155
"mcpServer": [
156156
[
157157
{
158-
"name": "@jephilli-patternfly-docs/mcp",
159-
"version": "1.1.0",
158+
"name": "@patternfly/patternfly-mcp",
159+
"version": "0.0.0",
160160
},
161161
{
162162
"capabilities": {

src/options.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ const OPTIONS: GlobalOptions = {
160160
separator: DEFAULT_SEPARATOR,
161161
urlRegex: URL_REGEX,
162162
name: packageJson.name,
163-
version: packageJson.version,
163+
version: (process.env.NODE_ENV === 'local' && '0.0.0') || packageJson.version,
164164
repoName: process.cwd()?.split?.('/')?.pop?.()?.trim?.(),
165165
contextPath: (process.env.NODE_ENV === 'local' && '/') || process.cwd(),
166166
docsPath: (process.env.NODE_ENV === 'local' && '/documentation') || join(process.cwd(), 'documentation'),

0 commit comments

Comments
 (0)