Red Hat API MCP Server

Red Hat API MCP Server

  

This project implements a Model Context Protocol (MCP) server that provides tools for interacting with Red Hat APIs, making it easy to integrate with LLM applications.

Table of Contents

• Features
• Prerequisites
• Installation
• Configuration
• Usage
• Available Tools
• Examples
• Troubleshooting
• Advanced Usage
• Contributing

Features

The server exposes the following Red Hat API tools:

1. Search Red Hat KCS Solutions - Search for knowledge base solutions
2. Get Solution by ID - Retrieve full solution content
3. Search Red Hat Cases - Find cases matching a query
4. Get Case Details - Retrieve detailed information about a specific case

Prerequisites

• Python 3.13 or higher
• UV package manager (recommended Python package manager)
• Red Hat API offline token (obtained from your Red Hat account)
• fastmcp (pip install fastmcp or uv pip install fastmcp)

Installation

1. Install UV (recommended)

UV is the recommended package manager for Python projects:

curl -LsSf https://astral.sh/uv/install.sh | sh

2. Clone and Setup Project

# Clone the repository
git clone <your-repository-url>
cd redhat-api-mcp

# Install dependencies with UV (recommended)
uv pip install -r requirements.txt

# Or with pip
pip install -r requirements.txt

Configuration

1. Get Your Red Hat API Token

1. Visit the Red Hat API Token Management page per KCS
2. Log in to your Red Hat account
3. Generate an offline token
4. Copy and save the token securely

2. Environment Setup

Create a .env file in the project root with your Red Hat API token:

# Create .env file
echo "RH_API_OFFLINE_TOKEN=your_offline_token_here" > .env

Replace your_offline_token_here with your actual offline token from step 1.

Usage

Running the MCP Server

You can run the server using fastmcp:

# Using UV (recommended)
uv run fastmcp run redhat_mcp_server.py

# Or using pip
fastmcp run redhat_mcp_server.py

This will start the MCP server on port 8000, allowing you to interact with your tools using any MCP client.

Integrating with Claude Desktop

To install the server in Claude Desktop, add this configuration to your Claude Desktop config file:

{
  "mcpServers": {
    "redhat": {
      "command": "fastmcp",
      "args": [
        "run",
        "/path/to/your/redhat-api-mcp/redhat_mcp_server.py"
      ],
      "env": {
        "RH_API_OFFLINE_TOKEN": "your_actual_offline_token_here"
      }
    }
  }
}

Available Tools

search_kcs

Search for Red Hat KCS Solutions and Articles.

search_kcs(query: str, rows: int = 50, start: int = 0) -> List[Dict]

Parameters:

• query (str): Search terms (supports advanced Solr syntax)
• rows (int, optional): Number of results to return (default: 50, max: 100)
• start (int, optional): Starting index for pagination (default: 0)

Returns: List of solution objects with id, title, score, and view_uri

get_kcs

Get a Red Hat solution by its ID and extract structured content.

get_kcs(solution_id: str) -> Dict

Parameters:

• solution_id (str): The KCS solution ID

Returns: Dictionary with title, environment, issue, resolution, and root_cause

search_cases

Search for Red Hat support cases.

search_cases(query: str, rows: int = 10, start: int = 0) -> List[Dict]

Parameters:

• query (str): Search terms
• rows (int, optional): Number of results to return (default: 10)
• start (int, optional): Starting index for pagination (default: 0)

Returns: List of case objects with case_number, summary, status, product, etc.

get_case

Get detailed information about a specific Red Hat support case.

get_case(case_number: str) -> Dict

Parameters:

• case_number (str): The Red Hat case number (e.g., "01234567")

Returns: Detailed case information with summary, description, severity, and comments

Advanced Usage

Advanced Query Parameters

For detailed information about using advanced Solr query expressions with the Red Hat Hydra API, see expression.md.

Prompt Templates

The server includes sophisticated prompt templates for case analysis:

• Case Summary: Generates C.A.S.E. format summaries
• Case Resolution: Provides investigation workflows
• Multi-phase Analysis: Advanced case resolution protocols

Custom Configuration

You can override default API endpoints by adding these to your .env file:

# Optional: Custom API endpoints
RH_API_BASE_URL=https://access.redhat.com
RH_SSO_URL=https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Note: This MCP server requires a valid Red Hat account and API access. Ensure you have the appropriate permissions for the Red Hat services you intend to access.