Skip to content

Commit 8c69e2c

Browse files
committed
docs: sharpen messaging and feature descriptions
Rewrite README and docs introduction to lead with the value proposition, reorder features to highlight AI-native capabilities first, and tighten descriptions across guides for clarity and consistency.
1 parent e26a1fb commit 8c69e2c

5 files changed

Lines changed: 21 additions & 19 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@
66
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?logo=apache)](LICENSE)
77
[![Version](https://img.shields.io/github/v/release/raystack/compass?logo=semantic-release)](Version)
88

9-
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.
9+
Compass is a context engine that builds a temporal knowledge graph of your organizationentities, relationships, and documents across every system — queryable by humans and AI agents alike. Search it. Traverse it. Reason over it.
1010

1111
## Key Features
1212

13+
- **AI-Native** -- Composable MCP tools let AI agents search, traverse, assess impact, and read documents over your organizational graph.
1314
- **Knowledge Graph** -- Typed, directed, temporal relationships between entities including lineage, ownership, and custom edge types.
15+
- **Context Assembly** -- Multi-hop bidirectional traversal builds a subgraph around any entity — the full picture in one call.
16+
- **Impact Analysis** -- Blast radius analysis traces what depends on what and what breaks when something changes.
1417
- **Hybrid Search** -- Keyword precision with semantic similarity using Postgres-native full-text search and pgvector embeddings.
15-
- **Context Assembly** -- Multi-hop bidirectional traversal builds a subgraph around any entity.
16-
- **Impact Analysis** -- Downstream blast radius analysis traces what breaks when something changes.
17-
- **Documents** -- Attach runbooks, decisions, and annotations to entities, indexed for semantic search.
18-
- **MCP Server** -- AI agents query the graph via Model Context Protocol.
19-
- **Open Type System** -- Any entity type, any edge type, any properties.
18+
- **Documents** -- Attach any document to entities — runbooks, decisions, postmortems, design docs — all indexed for semantic search.
19+
- **Open Type System** -- Any entity type, any edge type, any properties. Hardware, software, operations, people — anything fits.
2020

2121
## Documentation
2222

docs/docs/guides/context.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,4 @@ With depth 2, it would also include any entities connected to the Kafka Topic an
6464

6565
## Impact Analysis
6666

67-
`impact` is the downstream-only counterpart to `get_context` — it answers "if I change this, what breaks?" by tracing edges in one direction. Same depth mechanics, same cycle detection, but only follows downstream relationships. Available as `entity impact` in the CLI, `GetEntityImpact` in the API, and `impact` in MCP.
67+
`impact` answers "if I change this, what breaks?" by tracing edges downstream from a root entity. Same depth mechanics and cycle detection as `get_context`, but follows relationships in one direction to map the blast radius. Available as `entity impact` in the CLI, `GetEntityImpact` in the API, and `impact` in MCP.

docs/docs/guides/documents.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Documents
3-
description: Attach runbooks, decisions, and annotations to entities.
3+
description: Attach any document to entities, indexed for semantic search.
44
order: 6
55
---
66

77
# Documents
88

9-
Documents are knowledge objects — runbooks, ADRs, annotations, decisions — linked to entities. They are stored as first-class objects, indexed for semantic search, and served through the MCP `get_documents` tool.
9+
Documents are knowledge objects linked to entities — runbooks, ADRs, postmortems, design docs, or any other document type. They are stored as first-class objects, indexed for semantic search, and served through the MCP `get_documents` tool.
1010

1111
## Document Model
1212

docs/docs/index.mdx

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,30 @@
11
---
22
title: Introduction
3-
description: Compass is a context engine that builds a knowledge graph of your organization's metadata for humans and AI agents.
3+
description: Compass is a context engine — a temporal knowledge graph queryable by engineers and AI agents.
44
order: 1
55
---
66

77
# Introduction
88

9-
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.
9+
Compass is a context engine that builds a temporal knowledge graph of your organizationentities, relationships, and documents across every system — queryable by humans and AI agents alike. Search it. Traverse it. Reason over it.
1010

1111
## The Problem
1212

13-
Organizational knowledge is fragmented. The same logical entity appears across multiple systems with different names, schemas, and levels of detail. Relationships live in people's heads, scattered across wikis, chat threads, and tribal knowledge. When someone needs context, they spend hours stitching it together. When AI agents need context, they have nowhere to look.
13+
Organizations build complex systems — hundreds of services, pipelines, models, devices, and operations — all deeply interdependent. The knowledge about how these things connect, why they exist, and what depends on what lives in people's heads, scattered docs, and tribal memory.
1414

15-
Compass solves this by acting as the resolution and serving layer for organizational metadata. It takes raw observations from collection systems like [Meteor](https://github.com/raystack/meteor), resolves them into unified entities, builds a graph of their relationships, and makes everything searchable and traversable.
15+
Every day, engineers waste hours assembling context manually. AI agents hallucinate because they have no grounded knowledge to reason over. Changes break things nobody predicted. The missing layer is context.
16+
17+
Compass is that layer. It takes raw observations from collection systems like [Meteor](https://github.com/raystack/meteor), resolves them into unified entities, builds a temporal graph of their relationships, and makes everything searchable and traversable — by humans and agents.
1618

1719
## Key Features
1820

21+
- **AI-Native** -- Composable MCP tools let AI agents search, traverse, assess impact, and read documents. Works with any MCP-compatible client.
1922
- **Knowledge Graph** -- Typed, directed, temporal relationships between entities including lineage, ownership, documentation, and custom edge types.
23+
- **Context Assembly** -- Multi-hop bidirectional traversal builds a subgraph around any entity — the full picture in one call.
24+
- **Impact Analysis** -- Blast radius analysis traces what depends on what and what breaks when something changes.
2025
- **Hybrid Search** -- Keyword precision combined with semantic similarity using Postgres-native full-text search and pgvector embeddings.
21-
- **Context Assembly** -- Multi-hop bidirectional traversal builds a subgraph around any entity, assembling the full picture.
22-
- **Impact Analysis** -- Downstream blast radius analysis traces what breaks when something changes.
23-
- **Documents** -- Attach runbooks, decisions, and annotations to entities, indexed for semantic search.
24-
- **MCP Server** -- AI agents query the graph via Model Context Protocol. Works with Claude Code, Cursor, and Windsurf.
25-
- **Open Type System** -- Any entity type, any edge type, any properties. Compass doesn't prescribe your domain model.
26+
- **Documents** -- Attach any document to entities — runbooks, decisions, postmortems, design docs — all indexed for semantic search.
27+
- **Open Type System** -- Any entity type, any edge type, any properties. Hardware, software, operations, people — anything fits.
2628

2729
## Interfaces
2830

docs/docs/internals/architecture.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Orchestrates graph traversal, hybrid search, and context composition:
4343
### Serving Layer
4444

4545
- **Connect RPC** — HTTP and gRPC via a single service definition. API definitions in [raystack/proton](https://github.com/raystack/proton).
46-
- **MCP Server** — Model Context Protocol at `/mcp` for AI agents. Four composable tools: `search_entities`, `get_context`, `impact`, `get_documents`.
46+
- **MCP Server** — Model Context Protocol at `/mcp` for AI agents. Composable tools for searching, understanding context, analyzing impact, and retrieving documents.
4747

4848
## Multi-Tenancy
4949

0 commit comments

Comments
 (0)