Quick Start

Prerequisites

• Python 3.12 or higher
• UV package manager
• Docker (for Apache AGE database)

Installation

1. Clone the repository

   git clone https://github.com/openshift-hyperfleet/kartograph.git
   cd kartograph

2. Configure environment

   Default Kartograph configuration files can be found in /env.

3. Run Kartograph

   Kartograph can quickly be run locally using docker compose:

   make run

   This will first start a Postgres instance with ApacheAGE installed and then start the Kartograph API.

What’s Next?

Using the MCP Server

Kartograph exposes an MCP (Model Context Protocol) server that allows AI agents like Claude to query the knowledge graph.

See the MCP Server Guide for connection instructions, available tools, resources, and examples.

Understanding the Architecture

Kartograph is built with Domain-Driven Design:

• Bounded Contexts - Learn about the six contexts
• DDD Patterns - See DDD principles in action

Core Concepts

• Mutation Schema - JSONL mutation operation reference
• Secure Enclave - How tenant isolation works