apunkt/ktx
1
0
Fork 0
mirror of https://github.com/Kaelio/ktx.git synced 2026-06-28 08:49:38 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: align "agent clients" and "data agents" terminology

Browse source 
Replace "client agents" with "agent clients" and "database agents" with
"data agents" across AGENTS.md, README.md, the docs-site copy, and the
matching setup-agents test description, matching the canonical
vocabulary in docs/terminology.md.

Also moves packages/cli/tsconfig.json's tsBuildInfoFile from
node_modules/.cache/ to dist/.tsbuildinfo so incremental builds survive
node_modules reinstalls.
This commit is contained in:
Andrey Avtomonov 2026-05-21 14:23:10 +02:00
parent 6c4d9e7051
commit 36805c4533
7 changed files with 13 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs-site/content/docs/community/contributing.mdx
View file

@ -156,22 +156,22 @@ uv run pytest -q
## Adding a connector
Database connectors live in `packages/cli/src/connectors/<name>/`. Each
Database connectors live in `packages/cli/src/connectors/<driver>/`. Each
connector implements the `KtxScanConnector` interface from the internal context
modules.
### Step 1: Scaffold the connector
Create a new directory at `packages/cli/src/connectors/<name>/` with:
Create a new directory at `packages/cli/src/connectors/<driver>/` with:
```text
packages/cli/src/connectors/<name>/
packages/cli/src/connectors/<driver>/
index.ts # Internal connector exports
connector.ts # KtxScanConnector implementation
dialect.ts # SQL dialect handling
```
Add any driver-specific npm dependency to `packages/cli/package.json`.
Add any connector-specific npm dependency to `packages/cli/package.json`.
### Step 2: Implement the connector
@ -199,7 +199,7 @@ and statistics.
Register the new connector in `packages/cli/src/local-scan-connectors.ts` and
`packages/cli/src/local-adapters.ts` so the CLI and scan engine can instantiate
it. Keep runtime loading dynamic when the driver is optional.
it. Keep runtime loading dynamic when the connector is optional.
### Step 5: Test

6
docs-site/content/docs/integrations/agent-clients.mdx
View file

@ -6,9 +6,9 @@ description: Set up ktx with Claude Code, Claude Desktop, Cursor, Codex, and Ope
**ktx** exposes context to end-user agents through MCP tools. The CLI remains the
admin surface for setup, ingest, status, daemon lifecycle, and debugging.
Run `ktx setup` and select your client agent targets, or configure manually
using the snippets below. Choose **Ask data questions with ktx MCP** for client
agents. Choose **Ask data questions + manage ktx with CLI commands** only when
Run `ktx setup` and select your agent client targets, or configure manually
using the snippets below. Choose **Ask data questions with ktx MCP** for agent
clients. Choose **Ask data questions + manage ktx with CLI commands** only when
a developer or operator agent also needs pinned `ktx` admin commands.
## Install with setup