Showroom Docs MCP Server

Quarkus MCP Server that indexes Red Hat product documentation and the "IA Development From Zero To Hero" workshop for OpenShift Lightspeed.


Project maintained by maximilianoPizarro Hosted on GitHub Pages — Theme by mattgraham

Architecture

Logo

English | Espanol

Architecture Overview

Architecture: OpenShift Lightspeed + MCP

Components

Showroom Docs MCP Server

Data Flow

  1. The user asks a question in the OLS console
  2. OLS API Server receives the query and sends it to the LLM
  3. The LLM invokes showroom-docs-mcp tools for documentation queries
  4. The MCP server searches 46 sanitized documents and returns relevant sections
  5. Content is auto-sanitized (PDF artifacts removed) and smart-truncated at paragraph boundaries
  6. The LLM generates a contextualized response using the retrieved documentation

MCP Tools

Tool Description Input
searchDocs Keyword search across all documentation query: string
listDocSections List all available document sections (no parameters)
getDocSection Get full content of a specific section (supports fuzzy matching) fileName: string
getDocSummary Get knowledge base overview and example questions (no parameters)

Tool Selection by the LLM

The LLM decides which tools to call based on the question:

Question Type Expected Tool
“How do I install Service Mesh?” searchDocs → searches documentation
“List all available documentation” listDocSections → returns index
“Show me the Developer Hub docs” getDocSection → returns full doc
“What products are indexed?” getDocSummary → returns overview
“How do I install Ansible?” searchDocs → searches developer docs
“Quick-start for Quarkus?” searchDocs → returns CLI commands and code

Tool Selection Flow

MCP Tool Selection Flow

Content Sources

Knowledge Base: 46 Indexed Documents

Product Documentation
OpenShift Service Mesh 3.3 docs.redhat.com
Connectivity Link 1.3 docs.redhat.com
Developer Hub 1.9 docs.redhat.com
OpenShift Lightspeed 1.0 docs.redhat.com
OpenShift Observability 1 docs.redhat.com
OpenTelemetry 3.9 docs.redhat.com
OpenShift Pipelines 1.21 docs.redhat.com
API Management 1 docs.redhat.com
OpenShift AI 1 docs.redhat.com

Technology Stack

Component Technology
Framework Quarkus 3.27.3
MCP Extension quarkus-mcp-server-http 1.8.1
Health Checks SmallRye Health
Container Base UBI9 OpenJDK 21 Runtime
Container Registry quay.io
Orchestration Kubernetes / OpenShift
Packaging Helm Chart