Research collection templates for handbook

[cdcabrera]

As a developer I need to review the current PF MCP collection template format to see if it can be applied to external collections.

Acceptance criteria

• Viability research and potential POC

  • formatting and ingesting handbook markdown into a parsable format, like JSON
    • review the formats used in the related PF MCP collections, metadata appears open with a few core requirements. Review the typings associated with the existing collections
    • a generation script, JS or shell can be considered
    • review and roughly establish the needed handbook metadata that can both be gathered by directory structure and yaml frontmatter
      • this may need compare/contrast with docs.json within the PF MCP, for reference or as a model
  • using the PF MCP collections tuple format to ingest said JSON, or other determined format
  • ingesting the collection format itself into the PF MCP
    • need to confirm if either "collections-as-plugins" or embedding the PF MCP server with collections is available.

• Open a formalized issue, or issues, for incorporating handbook data/docs into the PF MCP

  • Reference any POC work created by this research story

Assumptions and questions

• Work that would help with this research

  • Collections-as-plugins would be the quickest avenue for consuming external collections. Currently, it is not implemented with the PF MCP. If/when work starts this should be re-confirmed
  • Wrapping the PF MCP server as an embedded MCP may be another avenue for applying custom collections. Currently, the option for external collections to be integrated is not available. If/when work starts this should be re-confirmed. Technically, implementation at the PF MCP server level would be more simplistic than "collections-as-plugins"

• Existing collection templates

  • collection.patternFlyApi.ts - can be used as reference for consuming an API iteratively
  • collection.patternFlyDocs.ts - can be used as reference for consuming a docs.json file
  • collection.patternFlySchemas.ts - can be used as reference for consuming a NPM package with an alternative "metadata" format

---

Jira Issue: PF-4564