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: README.md
+17-79Lines changed: 17 additions & 79 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,37 +72,18 @@ The MCP server communicates over stdio and provides access to PatternFly documen
72
72
73
73
### Available Tools
74
74
75
-
#### `list_documentation`
76
-
Lists available PatternFly documentation categories and files.
75
+
#### `usePatternFlyDocs`
76
+
Provides a list of URLs to `llms.txt` files that should be chosen to read for a particular context. These `llms.txt` files contain
77
+
a list of URLs to be read by the following `fetchDocs` tool.
77
78
78
79
**Parameters:**
79
-
-`path` (string, optional): Specific directory path to list (relative to documentation)
80
+
-`urlList` (array of strings, required): Specific directory path to list (relative to the `llms-files` directory)
80
81
81
-
#### `get_documentation`
82
-
Retrieves the full content of a specific PatternFly documentation file.
82
+
#### `fetchDocs`
83
+
Retrieves the full content of a specific PatternFly `llms.txt` files.
83
84
84
85
**Parameters:**
85
-
-`file_path` (string, required): Path to the documentation file (relative to documentation)
86
-
87
-
#### `search_documentation`
88
-
Searches for specific text across all PatternFly documentation files.
89
-
90
-
**Parameters:**
91
-
-`query` (string, required): Text to search for in the documentation
92
-
-`case_sensitive` (boolean, optional): Whether the search should be case sensitive (default: false)
93
-
94
-
#### `get_quick_rules`
95
-
Gets essential PatternFly development rules and guidelines for specific categories.
96
-
97
-
**Parameters:**
98
-
-`category` (string, optional): Specific category of rules (charts, chatbot, component-groups, components, guidelines, resources, setup, troubleshooting). If not provided, returns overview of all categories.
99
-
100
-
#### `get_all_standards`
101
-
Gets comprehensive PatternFly standards and guidelines from all documentation in a single response.
102
-
103
-
**Parameters:**
104
-
-`include_examples` (boolean, optional): Whether to include code examples and detailed explanations (default: true)
105
-
-`sections` (array, optional): Specific sections to include (charts, chatbot, component-groups, components, guidelines, resources, setup, troubleshooting). If not provided, includes all sections.
86
+
-`urls` (array of strings, required): Path to the documentation file (relative to documentation)
106
87
107
88
### Example Client Integration
108
89
@@ -114,7 +95,7 @@ Example configuration for MCP clients using npx (see `mcp-config-example.json`):
[About PatternFly](https://raw.githubusercontent.com/patternfly/patternfly-org/refs/heads/main/packages/documentation-site/patternfly-docs/content/get-started/about-patternfly.md): <classification>LLM should read this page when assisting with understanding what PatternFly is, why to use it, who should use it, and where to start.</classification>
5
+
[Design with PatternFly](https://github.com/patternfly/patternfly-org/blob/main/packages/documentation-site/patternfly-docs/content/get-started/design-with-figma.md): <classification>LLM should read this page when assisting with how to design using PatternFly</classification>
6
+
[Develop with PatternFly](https://github.com/patternfly/patternfly-org/blob/main/packages/documentation-site/patternfly-docs/content/get-started/develop.md): <classification>LLM should read this page when assisting with how to get started developing with PatternFly. It describes the design system and token system and includes information about the PatternFly React libraries used to build interfaces with consistent markup, styling and behavior.</classification>
7
+
8
+
## Migration
9
+
[Migrating to v6: Upgrade guid](https://raw.githubusercontent.com/patternfly/patternfly-org/refs/heads/main/packages/documentation-site/patternfly-docs/content/get-started/upgrade.md): <classification>LLM should read this page when assisting with migrating a project from PatternFly React version 5 to version 6. It is useful for guiding updates to dependencies, package names, React and TypeScript versions, styling solutions, and running codemods to handle breaking changes. This document is essential for ensuring compatibility with React 18, adopting the new Emotion styling engine, and addressing key migration steps and potential issues.</classification>
10
+
11
+
## Design Foundations
12
+
13
+
[Colors](https://raw.githubusercontent.com/patternfly/patternfly-org/refs/heads/main/packages/documentation-site/patternfly-docs/content/design-guidelines/styles/colors/colors.md): <classification>LLM should read this page when assisting with choosing colors using PatternFly's color palette</classification>
14
+
[Icons](https://raw.githubusercontent.com/patternfly/patternfly-org/refs/heads/main/packages/documentation-site/patternfly-docs/content/design-guidelines/styles/icons/icons.md): <classification>LLM should read this page when assisting with choosing colors using PatternFly's color palette</classification>
15
+
[Motion](): <classification></classification>
16
+
[Typography](): <classification></classification>
17
+
[Usage and behaviour](): <classification></classification>
[About PatternFly](https://raw.githubusercontent.com/patternfly/patternfly-org/refs/heads/main/packages/documentation-site/patternfly-docs/content/get-started/about-patternfly.md): <classification>LLM should read this page when assisting with understanding what PatternFly is, why to use it, who should use it, and where to start.</classification>
5
+
[Design with PatternFly](https://github.com/patternfly/patternfly-org/blob/main/packages/documentation-site/patternfly-docs/content/get-started/design-with-figma.md): <classification>LLM should read this page when assisting with how to design using PatternFly</classification>
6
+
[Develop with PatternFly](https://github.com/patternfly/patternfly-org/blob/main/packages/documentation-site/patternfly-docs/content/get-started/develop.md): <classification>LLM should read this page when assisting with how to get started developing with PatternFly. It describes the design system and token system and includes information about the PatternFly React libraries used to build interfaces with consistent markup, styling and behavior.</classification>
7
+
8
+
## Colors for Charts
9
+
[Migrating to v6: Upgrade guid](https://raw.githubusercontent.com/patternfly/patternfly-org/refs/heads/main/packages/documentation-site/patternfly-docs/content/get-started/upgrade.md): <classification>LLM should read this page when assisting with migrating a project from PatternFly React version 5 to version 6. It is useful for guiding updates to dependencies, package names, React and TypeScript versions, styling solutions, and running codemods to handle breaking changes. This document is essential for ensuring compatibility with React 18, adopting the new Emotion styling engine, and addressing key migration steps and potential issues.</classification>
10
+
11
+
## Charts
12
+
[Area Chart](https://raw.githubusercontent.com/patternfly/patternfly-react/refs/heads/main/packages/react-charts/src/charts/area-chart/area-chart.md): <classification>LLM should read this page when assisting with choosing colors using PatternFly's color palette</classification>
13
+
[Icons](https://raw.githubusercontent.com/patternfly/patternfly-org/refs/heads/main/packages/documentation-site/patternfly-docs/content/design-guidelines/styles/icons/icons.md): <classification>LLM should read this page when assisting with choosing colors using PatternFly's color palette</classification>
14
+
[Motion](): <classification></classification>
15
+
[Typography](): <classification></classification>
16
+
[Usage and behaviour](): <classification></classification>
0 commit comments