Skip to main content
Glama
patternfly

PatternFly MCP Server

Official
by patternfly
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

usePatternFlyDocs

Fetch PatternFly documentation and component JSON schemas by name or patternfly:// URI to help developers build UIs with correct component details.

Instructions

Get markdown documentation and component JSON schemas for PatternFly resources and components.

  **Usage**:
    1. Input a component or resource name (e.g., "Button", "Writing") OR a list of up to 15 patternfly:// URIs or documentation URLs at a time (typically from searchPatternFlyDocs results).

  **Returns**:
    - Markdown documentation
    - Component JSON schemas, if available

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoThe name of a PatternFly component or patternfly:// URI resource to fetch documentation for (e.g., "Button", "patternfly://docs/Button")
urlListNoThe list of patternfly:// URIs or URLs to fetch the documentation from (max 15 at a time)
versionNoFilter results by a specific collection version (e.g. "v5", "v6")

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.5.0
    • changedInput schema / properties / version / description
      Previous value: -"Filter results by a specific PatternFly version (e.g. \"current\", \"latest\", \"v6\")"New value: +"Filter results by a specific collection version (e.g. \"v5\", \"v6\")"
    • removedInput schema / properties / version / enum
      Removed value: -[
-  "current",
-  "latest",
-  "v6"
-]
  2. Changed5 schema fields changedv2.0.1
    • changedInput schema / properties / name / description
      Previous value: -"The name of a PatternFly component or resource to fetch documentation for (e.g., \"Button\", \"Table\", \"Writing\")"New value: +"The name of a PatternFly component or patternfly:// URI resource to fetch documentation for (e.g., \"Button\", \"patternfly://docs/Button\")"
    • changedInput schema / properties / urlList / description
      Previous value: -"The list of URLs to fetch the documentation from (max 15 at a time"New value: +"The list of patternfly:// URIs or URLs to fetch the documentation from (max 15 at a time)"
    • addedInput schema / properties / urlList / items / format
      Added value: +"uri"
    • addedInput schema / properties / urlList / items / maxLength
      Added value: +1500
    • addedInput schema / properties / urlList / items / minLength
      Added value: +11
  3. Changed5 schema fields changedv1.1.0
    • addedInput schema / properties / name
      Added value: +{
+  "description": "The name of a PatternFly component or resource to fetch documentation for (e.g., \"Button\", \"Table\", \"Writing\")",
+  "maxLength": 256,
+  "type": "string"
+}
    • changedInput schema / properties / urlList / description
      Previous value: -"The list of urls to fetch the documentation from"New value: +"The list of URLs to fetch the documentation from (max 15 at a time"
    • addedInput schema / properties / urlList / maxItems
      Added value: +15
    • addedInput schema / properties / version
      Added value: +{
+  "description": "Filter results by a specific PatternFly version (e.g. \"current\", \"latest\", \"v6\")",
+  "enum": [
+    "current",
+    "latest",
+    "v6"
+  ],
+  "type": "string"
+}
    • removedInput schema / required
      Removed value: -[
-  "urlList"
-]
  4. First observedv1.0.0

TDQS

A3.6/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full disclosure burden. It does disclose the output shape (markdown docs, optional component JSON schemas) and the 15-item batch cap, but says nothing about authentication, rate limits, error behavior, or read-only status beyond the implied 'Get'.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with a clear one-sentence purpose, then bolded Usage and Returns sections. Slightly header-heavy for a three-field tool, but every block conveys actionable information and there is no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Return values are summarized, which matters since there is no output schema. However, the description omits the version filter entirely and does not clarify what happens if both name and urlList are supplied or if neither is (0 required parameters) — a real gap given the schema allows an empty call.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents name, urlList, and version thoroughly, including examples and the max-15 constraint. The description repeats the input forms but adds no new semantics, and it never mentions the version parameter at all.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: fetch markdown documentation and component JSON schemas for PatternFly components. The relationship to searchPatternFlyDocs is hinted at ('typically from searchPatternFlyDocs results'), suggesting this is the retrieval step after a search, but the distinction is not stated explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The Usage section clearly explains the two input modes (a name or a list of up to 15 URIs) and where the URIs come from (searchPatternFlyDocs results). It does not state when to prefer this tool over searchPatternFlyDocs, but the workflow context is clear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools