Skip to content

Commit 236e946

Browse files
committed
fix: review add
1 parent ec2af13 commit 236e946

3 files changed

Lines changed: 18 additions & 0 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,10 @@ main();
9494

9595
For comprehensive usage, development, and project state [read the docs](./docs/README.md).
9696

97+
- **Architecture**: Learn about our [hybrid documentation model and data sources](./docs/architecture.md#data-sources-and-integrations).
98+
- **Usage**: Detailed guide on [built-in tools and resources](./docs/usage.md).
99+
- **Development**: Reference for [CLI options and tool plugins](./docs/development.md).
100+
97101
## Contributing
98102

99103
Contributing? Guidelines can be found here [CONTRIBUTING.md](./CONTRIBUTING.md).

docs/architecture.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,18 @@ We'll be introducing our hybrid documentation model in upcoming releases. This c
2828
- **Baseline data**: Core guidelines and standards integrated directly into the server for standalone purposes, quick starts, and immediate access.
2929
- **Dynamic content**: Content synced from the latest available PatternFly implementation while you work, ensuring the LLM always has access to the latest documentation and patterns.
3030

31+
### Data sources and integrations
32+
33+
The PatternFly MCP server aggregates content from multiple official sources to provide a comprehensive development resource.
34+
35+
#### PatternFly ai-helpers
36+
The server integrates the [patternfly/ai-helpers](https://github.com/patternfly/ai-helpers) repository to provide specialized, LLM-optimized guidance. This integration powers several key resource categories:
37+
- **AI Guidance**: Specialized patterns for React Charts, Chatbot, and general React development.
38+
- **Styling Standards**: CSS and styling requirements tailored for AI code generation.
39+
- **Prompt Engineering**: Includes `ai-prompt-guidance.md` to help users write more effective prompts for PatternFly.
40+
41+
These helpers are a core part of our [Hybrid documentation model](#hybrid-documentation-model-in-progress), acting as the bridge between stable design patterns and dynamic implementation details.
42+
3143
### Tools, resources, and prompts as customizable plugins
3244

3345
Tools, resources, and prompts as customizable plugins are the result of predictable MCP SDK patterns. In the case of the PatternFly MCP server,

docs/usage.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ Fetch full documentation and component JSON schemas for specific PatternFly URLs
6666
6767
The server exposes a resource-centric architecture via the `patternfly://` URI scheme. MCP clients can use these resources directly. [Review the roadmap for future resource updates](./architecture.md#roadmap).
6868

69+
> **Note on AI Content**: Specialized resources such as `patternfly://docs/react-guidelines` and `patternfly://docs/ai-prompt-guidance` are sourced from the [patternfly/ai-helpers](https://github.com/patternfly/ai-helpers) integration. These are specifically optimized to help LLMs generate more accurate PatternFly code. [See Data sources and integrations in architecture](./architecture.md#data-sources-and-integrations).
70+
6971
### Discovery resources
7072

7173
Use these indexes to discover what is available in the library:

0 commit comments

Comments
 (0)