README.md

Horreum MCP Documentation

Complete documentation for the Horreum Model Context Protocol Server.

Getting Started

Building a Domain MCP? Start with the Domain MCP Integration Guide - a complete guide to building specialized AI assistants using Horreum MCP as a data source.

Using Horreum MCP standalone? See the User Guide for features and configuration.

Documentation Structure

For Users

• User Guide - Complete user documentation
  • Label Values Filtering
  • Time Range Queries
  • Observability

For Developers

• Developer Guide - Contributing and development
  • CI Security Scanning
  • CI Workflow Architecture

For Operations

• Deployment Guide - Deployment documentation
  • Kubernetes/OpenShift
  • SSL/TLS Configuration

Architecture & Troubleshooting

• Architecture - Technical architecture
  • Domain MCP Integration - Build Domain MCPs ⭐
  • Source MCP Contract
• Troubleshooting - Issue resolution
  • Horreum API Bugs
  • Pagination Issues

Quick Reference

Standard Configuration

All examples in this documentation use consistent defaults:

• Horreum URL: https://horreum.example.com
• HTTP Port: 3000
• Test Names: performance-test, boot-time-test
• Tokens: Shown as horreum_*** or REDACTED

Getting Help

• 📖 Main README - Project overview
• 🐛 Issue Tracker
• 💬 Discussions
• 📚 Horreum Docs