Skip to content

raystack/compass

Repository files navigation

Compass

test workflow release workflow Coverage Status License Version

Compass is a context engine that builds a knowledge graph of your organization's metadata, capturing entities, relationships, and lineage across systems and time, making it discoverable and queryable for both humans and AI agents.

Key Features

  • Knowledge Graph -- Typed, directed, temporal relationships between entities including lineage, ownership, and custom edge types.
  • Hybrid Search -- Keyword precision with semantic similarity using Postgres-native full-text search and pgvector embeddings.
  • Context Assembly -- Multi-hop bidirectional traversal builds a subgraph around any entity.
  • Impact Analysis -- Downstream blast radius analysis traces what breaks when something changes.
  • Documents -- Attach runbooks, decisions, and annotations to entities, indexed for semantic search.
  • MCP Server -- AI agents query the graph via Model Context Protocol.
  • Open Type System -- Any entity type, any edge type, any properties.

Documentation

  • Quickstart -- Get running in 5 minutes
  • Guides -- Entities, edges, search, context, MCP, CLI, API
  • Internals -- Architecture, search engine, storage

Installation

Install Compass on macOS, Windows, Linux, or via Docker.

macOS

brew install raystack/tap/compass

Linux

Download .deb or .rpm from releases:

sudo dpkg -i compass_*.deb

Docker

docker pull raystack/compass:latest

Build from Source

git clone https://github.com/raystack/compass.git
cd compass && make

Usage

# Start PostgreSQL
docker-compose up -d

# Initialize and run
compass config init
compass server migrate
compass server start

# Search the graph
compass entity search "orders" --mode hybrid

# Explore context
compass entity context urn:bigquery:orders --depth 2

# Analyze impact
compass entity impact urn:kafka:events --depth 3

MCP Server

Connect AI agents to Compass via MCP. Add to .mcp.json:

{
  "mcpServers": {
    "compass": {
      "type": "sse",
      "url": "http://localhost:8080/mcp"
    }
  }
}

License

Compass is Apache 2.0 licensed.

About

Compass is a context engine that builds a knowledge graph of your organization's metadata, capturing entities, relationships, and lineage across systems and time, making it discoverable and queryable for both humans and AI agents.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Contributors

Languages