mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
56a967278a
* chore(docs-site): add dev shortcut and fix hero heading clipping - Add `pnpm docs` script that frees port 3000 then runs the docs-site dev server, so the docs preview is one command away. - Bump hero heading line-height to 1.2 and add 0.15em bottom padding so the gradient text-clip no longer cuts off descenders. - Sync auto-generated next-env.d.ts to the current Next types path. * fix(ci): unblock CI on docs-font branch - Add lsof to knip ignoreBinaries so the new `pnpm docs` script (which uses `lsof -ti:3000` to free port 3000) does not trip the Unlisted binaries check. - Make CLI version assertions read @ktx/cli/package.json at runtime instead of hardcoding 0.0.0-private. The 0.4.0 release commit on main bumped the package version, breaking 18 hardcoded test cases in index.test.ts and admin-reindex.test.ts; reading the version dynamically keeps the suite green across future version bumps. * fix ci release version fixtures
107 lines
4.6 KiB
Text
107 lines
4.6 KiB
Text
---
|
|
title: Introduction
|
|
description: ktx is an open-source, self-improving context layer for data agents.
|
|
---
|
|
|
|
import { ProductMechanics } from "@/components/product-mechanics";
|
|
|
|
<div className="not-prose mb-10">
|
|
<div>
|
|
<h1
|
|
className="max-w-full text-3xl font-extrabold tracking-tight break-words sm:text-4xl lg:text-5xl"
|
|
style={{
|
|
fontFamily: 'var(--font-display)',
|
|
background: 'linear-gradient(180deg, var(--color-fd-foreground) 0%, color-mix(in oklch, var(--color-fd-foreground) 75%, var(--color-fd-primary)) 100%)',
|
|
WebkitBackgroundClip: 'text',
|
|
backgroundClip: 'text',
|
|
color: 'transparent',
|
|
WebkitTextFillColor: 'transparent',
|
|
lineHeight: '1.2',
|
|
letterSpacing: '0',
|
|
paddingBottom: '0.15em',
|
|
}}
|
|
>
|
|
Make analytics context usable by agents
|
|
</h1>
|
|
<p className="mt-4 max-w-2xl text-lg text-fd-muted-foreground" style={{ lineHeight: '1.7' }}>
|
|
{'ktx is an open-source context layer for data agents. It turns warehouse metadata, BI tool definitions, query history, docs, and approved metric definitions into reviewable files agents can search and execute.'}
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
## Why ktx helps
|
|
|
|
**ktx** gives agents a shared context workspace before they write SQL, answer a
|
|
question, or update analytics definitions.
|
|
|
|
- **Context as code.** **ktx** writes wiki pages and semantic-layer definitions as
|
|
git-based files you can review, diff, and merge.
|
|
- **Self-improving ingest.** **ktx** reads warehouses, BI tools, modeling code,
|
|
query history, and notes, then reconciles new evidence with accepted context.
|
|
- **Executable semantics.** Agents can use approved measures, joins, filters,
|
|
dimensions, and segments instead of rebuilding canonical SQL from scratch.
|
|
- **Agent-native access.** CLI and MCP tools let agents search context, compile
|
|
semantic queries, run read-only SQL, and propose updates.
|
|
|
|
**ktx** complements existing semantic layers by pairing metric definitions with the
|
|
surrounding business knowledge, caveats, provenance, and review workflow agents
|
|
need for data work.
|
|
|
|
## How ktx works
|
|
|
|
**ktx** has two connected sides: it builds and maintains the context layer, then
|
|
serves that context to agents at runtime.
|
|
|
|
| Side | What **ktx** does |
|
|
|------|---------------|
|
|
| **Ingest and auto-maintain knowledge** | Reads your data stack and company knowledge, reconciles new evidence with accepted context, and keeps changes to `semantic-layer/` plus `wiki/` as version-controlled diffs automatically. |
|
|
| **Serve agents at runtime** | Helps agents find the right wiki pages and semantic-layer entities, then compile or execute semantic queries through CLI and MCP tools. |
|
|
|
|
<ProductMechanics />
|
|
|
|
## Use it for
|
|
|
|
Use **ktx** when agents need more than raw database access. Agents can search wiki
|
|
context, find semantic-layer entities, compile trusted semantic queries, run
|
|
read-only SQL, and use the same tools through MCP.
|
|
|
|
- Generate SQL from approved metrics, joins, filters, and dimensions.
|
|
- Explain metric provenance with wiki content and source evidence.
|
|
- Repair context through reviewable YAML and Markdown diffs.
|
|
- Work alongside dbt, MetricFlow, LookML, Looker, Metabase, Notion, and
|
|
supported databases.
|
|
|
|
## Start here
|
|
|
|
Choose the route that matches what you want to do next. The quickstart is the
|
|
best first step for users; contributor setup lives in the community docs.
|
|
|
|
<Cards>
|
|
<Card title="Quickstart" href="/docs/getting-started/quickstart">
|
|
Install **ktx**, run setup, build context, and connect an agent.
|
|
</Card>
|
|
<Card title="The Context Layer" href="/docs/concepts/the-context-layer">
|
|
Understand why agents need more than schema access and raw SQL.
|
|
</Card>
|
|
<Card title="Building Context" href="/docs/guides/building-context">
|
|
Refresh context from databases, BI tools, query history, and documents.
|
|
</Card>
|
|
<Card title="Writing Context" href="/docs/guides/writing-context">
|
|
Edit semantic-layer YAML and wiki Markdown safely.
|
|
</Card>
|
|
<Card title="CLI Reference" href="/docs/cli-reference/ktx">
|
|
Complete flag and subcommand reference for every **ktx** command.
|
|
</Card>
|
|
<Card title="Agent Quickstart" href="/docs/ai-resources/agent-quickstart">
|
|
Machine-readable docs and agent-facing setup notes.
|
|
</Card>
|
|
</Cards>
|
|
|
|
## Community
|
|
|
|
Have questions, want to share what you're building, or chat with maintainers?
|
|
Join the [**ktx** Slack community](https://join.slack.com/t/ktxcommunity/shared_invite/zt-3y9b44m1x-LVyNNJD5nwaZHq4XS29LMQ).
|
|
For bug reports and feature requests, open a
|
|
[GitHub issue](https://github.com/Kaelio/ktx/issues). See
|
|
[Community & Support](/docs/community/support) for the full guide on where to
|
|
ask what.
|