Skip to main content
Glama
patternfly

PatternFly MCP Server

Official
by patternfly

componentSchemas

Retrieve JSON Schema for PatternFly React components to access prop definitions, types, and validation rules for structured component metadata.

Instructions

Get JSON Schema for a PatternFly React component. Returns prop definitions, types, and validation rules. Use this for structured component metadata, not documentation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
componentNameYesName of the PatternFly component (e.g., "Button", "Table")
Behavior3/5

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

With no annotations provided, the description carries the full burden. It discloses the return content ('prop definitions, types, and validation rules') which is helpful, but doesn't mention potential behaviors like error handling (e.g., if componentName is invalid), rate limits, or authentication needs. It adds some value but lacks comprehensive behavioral context.

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

Conciseness5/5

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

The description is two sentences with zero waste: the first states the purpose and return value, the second provides usage guidance. It's front-loaded with the core function and appropriately sized for a single-parameter tool.

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

Completeness4/5

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

Given the tool's low complexity (1 parameter, no output schema, no annotations), the description is mostly complete: it covers purpose, usage, and return content. However, without annotations or output schema, it could benefit from more behavioral details (e.g., error cases) to be fully comprehensive, but it's adequate for this context.

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 fully documents the single parameter componentName. The description doesn't add any parameter-specific details beyond what's in the schema (e.g., no examples beyond 'Button', 'Table', or validation rules). Baseline 3 is appropriate as the schema does the heavy lifting.

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

Purpose5/5

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

The description clearly states the tool's purpose with specific verbs ('Get JSON Schema') and resource ('PatternFly React component'), and distinguishes it from siblings by specifying it's for 'structured component metadata, not documentation' (implying fetchDocs/usePatternFlyDocs are for documentation).

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 description provides clear context on when to use this tool ('for structured component metadata') and when not to ('not documentation'), which implicitly suggests alternatives like fetchDocs or usePatternFlyDocs for documentation purposes. However, it doesn't explicitly name the sibling tools or provide exclusion criteria beyond the documentation distinction.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/patternfly/patternfly-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server