mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-10 08:05:14 +02:00
2c9a58bb56
Bare invocations now do the obvious thing instead of erroring out, and mode-as-subcommand patterns collapse into flags on the parent. No new top-level commands. - `ktx ingest` (bare) ingests every configured connection. The `text` subcommand is gone; capture inline notes with `ktx ingest --text "..."` and files with `ktx ingest --file path` (use `-` for stdin). `--text`/`--file` reject a positional connection id; pass `--connection-id` to tag captured notes. - `ktx connection` (bare) lists; `ktx connection test` (bare) tests every configured connection. - `ktx wiki` and `ktx sl` flatten `list`/`search`: bare lists, with a `[query...]` positional searches (multi-word joined with spaces). `sl validate` and `sl query` stay as distinct verbs and now read `--connection-id` from the parent. - `ktx mcp` (bare) prints daemon status. Adds a shared `resolveConnectionSelection` helper consumed by ingest and connection test. Updates README, docs-site cli-reference and guides, next-steps strings, agent SKILL templates, and all affected tests. Per-package type-check, unit tests (605), smoke tests, and dead-code checks all pass.
160 lines
4.4 KiB
Text
160 lines
4.4 KiB
Text
---
|
|
title: Serving Agents
|
|
description: Expose KTX context to Claude Code, Codex, Cursor, OpenCode, and custom agents.
|
|
---
|
|
|
|
KTX serves agents through the CLI and project-local instruction files. Agents
|
|
read generated rules, call KTX commands, inspect context files, and use JSON for
|
|
structured results.
|
|
|
|
## Recommended setup
|
|
|
|
Run the agent install step from a KTX project:
|
|
|
|
```bash
|
|
ktx setup --agents
|
|
```
|
|
|
|
Or install a specific target:
|
|
|
|
```bash
|
|
ktx setup --agents --target codex
|
|
```
|
|
|
|
Supported targets:
|
|
|
|
| Target | Generated project file |
|
|
|--------|------------------------|
|
|
| Claude Code | `.claude/skills/ktx/SKILL.md` |
|
|
| Codex | `.agents/skills/ktx/SKILL.md` |
|
|
| Cursor | `.cursor/rules/ktx.mdc` |
|
|
| OpenCode | `.opencode/commands/ktx.md` |
|
|
| Universal `.agents` | `.agents/skills/ktx/SKILL.md` |
|
|
|
|
Claude Code and Codex also support global installs:
|
|
|
|
```bash
|
|
ktx setup --agents --target claude-code --global
|
|
ktx setup --agents --target codex --global
|
|
```
|
|
|
|
Installed files are recorded in `.ktx/agents/install-manifest.json`. Rerun
|
|
`ktx setup --agents` after moving a checkout or reinstalling the CLI.
|
|
|
|
## Agent command set
|
|
|
|
All supported clients use the same command surface. Use `--project-dir` outside
|
|
the KTX project directory.
|
|
|
|
### Readiness
|
|
|
|
```bash
|
|
ktx status --json
|
|
```
|
|
|
|
Run this before relying on context. It reports project, provider, connection,
|
|
context-build, and agent-integration readiness.
|
|
|
|
### Semantic layer discovery
|
|
|
|
```bash
|
|
ktx sl --json
|
|
ktx sl --connection-id warehouse --json
|
|
ktx sl "revenue" --json --limit 10
|
|
```
|
|
|
|
Use these commands to find source names, connection ids, measures, dimensions,
|
|
and files to inspect.
|
|
|
|
### Semantic-layer validation and queries
|
|
|
|
```bash
|
|
ktx sl validate orders --connection-id warehouse
|
|
```
|
|
|
|
Compile SQL before executing:
|
|
|
|
```bash
|
|
ktx sl query \
|
|
--connection-id warehouse \
|
|
--measure orders.total_revenue \
|
|
--dimension orders.created_date \
|
|
--format sql
|
|
```
|
|
|
|
Execute only when the task calls for live data:
|
|
|
|
```bash
|
|
ktx sl query \
|
|
--connection-id warehouse \
|
|
--measure orders.total_revenue \
|
|
--dimension orders.status \
|
|
--execute \
|
|
--max-rows 100
|
|
```
|
|
|
|
For complex calls, agents can write a JSON query object and pass it with
|
|
`--query-file`.
|
|
|
|
### Wiki context
|
|
|
|
```bash
|
|
ktx wiki --json
|
|
ktx wiki "revenue recognition" --json --limit 10
|
|
```
|
|
|
|
Search wiki context for business definitions, metric caveats, process rules, and
|
|
non-obvious terms.
|
|
|
|
### Context refresh
|
|
|
|
Agents can refresh context when the user asks them to:
|
|
|
|
```bash
|
|
ktx ingest warehouse --fast
|
|
ktx ingest
|
|
ktx ingest --file docs/revenue-notes.md --connection-id warehouse
|
|
```
|
|
|
|
Use `--deep` only when LLM and embedding setup is ready.
|
|
|
|
## Good agent behavior
|
|
|
|
Agents should:
|
|
|
|
- Run `ktx status --json` before using KTX context.
|
|
- Use `ktx sl <query>` and `ktx wiki <query>` before writing SQL from memory.
|
|
- Inspect the relevant YAML or Markdown files after search returns candidates.
|
|
- Compile SQL with `ktx sl query --format sql` before executing.
|
|
- Use `--max-rows` whenever executing a live query.
|
|
- Validate edited semantic sources with `ktx sl validate`.
|
|
- Keep generated context changes reviewable in git.
|
|
|
|
KTX is a local context layer with a CLI and plain project files. Do not assume a
|
|
background server, ORPC route, frontend app, or external migration system.
|
|
|
|
## Manual setup
|
|
|
|
Use manual setup for custom agents that can read project-local instructions.
|
|
|
|
1. Install the universal target:
|
|
|
|
```bash
|
|
ktx setup --agents --target universal
|
|
```
|
|
|
|
2. Configure the agent to read `.agents/skills/ktx/SKILL.md`.
|
|
3. Open the agent in the KTX project directory.
|
|
4. Ask it to run `ktx status --json` and summarize readiness.
|
|
|
|
For per-client notes, see [Agent Clients](/docs/integrations/agent-clients).
|
|
|
|
## Troubleshooting
|
|
|
|
| Symptom | Likely cause | Recovery |
|
|
|---------|--------------|----------|
|
|
| Agent says KTX is unavailable | Agent did not load the generated instruction file | Rerun `ktx setup --agents --target <target>` and restart the agent session |
|
|
| Agent command cannot find the project | Agent is running outside the KTX directory | Add `--project-dir <path>` or open the agent in the project root |
|
|
| Generated rules point at a missing CLI path | CLI was moved, rebuilt, or reinstalled | Rerun `ktx setup --agents` |
|
|
| Agent cannot find a metric | Context is missing or stale | Run `ktx sl <query>`, inspect source YAML, then refresh with `ktx ingest` if needed |
|
|
| Agent query returns too many rows | The command executed without a result cap | Require `--max-rows` for executed queries |
|