From 36805c4533f968a8111dde04d3a7ce9a47737eb6 Mon Sep 17 00:00:00 2001 From: Andrey Avtomonov Date: Thu, 21 May 2026 14:23:10 +0200 Subject: [PATCH] docs: align "agent clients" and "data agents" terminology 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. --- AGENTS.md | 2 +- README.md | 2 +- docs-site/components/semantic-layer-flow.tsx | 2 +- docs-site/content/docs/community/contributing.mdx | 10 +++++----- docs-site/content/docs/integrations/agent-clients.mdx | 6 +++--- packages/cli/src/setup-agents.test.ts | 2 +- packages/cli/tsconfig.json | 2 +- 7 files changed, 13 insertions(+), 13 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index d5f41bcd..028da8d0 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,6 +1,6 @@ # ktx Development Notes -**ktx** is a standalone open-source context layer for database agents. These +**ktx** is a standalone open-source context layer for data agents. These instructions apply to all agents working in this repository (Codex, Claude, Gemini, and similar tools). Do not assume an external app server, frontend, database migrations, ORPC contracts, or `python-service/` layout exist here. diff --git a/README.md b/README.md index e905f8dd..b6f0494e 100644 --- a/README.md +++ b/README.md @@ -153,7 +153,7 @@ ktx wiki "refund policy" --json ktx sl query --connection-id warehouse --measure orders.revenue --format sql ``` -During setup, choose **Ask data questions with ktx MCP** for client agents. +During setup, choose **Ask data questions with ktx MCP** for agent clients. Choose **Ask data questions + manage ktx with CLI commands** when an operator agent also needs pinned `ktx` admin commands. diff --git a/docs-site/components/semantic-layer-flow.tsx b/docs-site/components/semantic-layer-flow.tsx index b62d291f..9406ed1d 100644 --- a/docs-site/components/semantic-layer-flow.tsx +++ b/docs-site/components/semantic-layer-flow.tsx @@ -124,7 +124,7 @@ const agent: AgentNode = { position: { x: AGENT_X, y: AGENT_Y }, data: { variant: "single", - title: "Analytics agent", + title: "Data agent", subtitle: "Asks: monthly net revenue and open tickets per segment, high-value orders only, no test customers", }, diff --git a/docs-site/content/docs/community/contributing.mdx b/docs-site/content/docs/community/contributing.mdx index 70c390ec..3d070993 100644 --- a/docs-site/content/docs/community/contributing.mdx +++ b/docs-site/content/docs/community/contributing.mdx @@ -156,22 +156,22 @@ uv run pytest -q ## Adding a connector -Database connectors live in `packages/cli/src/connectors//`. Each +Database connectors live in `packages/cli/src/connectors//`. 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//` with: +Create a new directory at `packages/cli/src/connectors//` with: ```text -packages/cli/src/connectors// +packages/cli/src/connectors// 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 diff --git a/docs-site/content/docs/integrations/agent-clients.mdx b/docs-site/content/docs/integrations/agent-clients.mdx index 23430e0c..f7281dda 100644 --- a/docs-site/content/docs/integrations/agent-clients.mdx +++ b/docs-site/content/docs/integrations/agent-clients.mdx @@ -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 diff --git a/packages/cli/src/setup-agents.test.ts b/packages/cli/src/setup-agents.test.ts index 52d0cdff..a5f488d5 100644 --- a/packages/cli/src/setup-agents.test.ts +++ b/packages/cli/src/setup-agents.test.ts @@ -380,7 +380,7 @@ describe('setup agents', () => { }); }); - it('prompts for MCP-first client agent connection mode in interactive setup', async () => { + it('prompts for MCP-first agent client connection mode in interactive setup', async () => { const io = makeIo(); const prompts = { select: vi.fn(async ({ message }: { message: string }) => (message.startsWith('Where') ? 'project' : 'mcp')), diff --git a/packages/cli/tsconfig.json b/packages/cli/tsconfig.json index b527c8a1..6590987d 100644 --- a/packages/cli/tsconfig.json +++ b/packages/cli/tsconfig.json @@ -4,7 +4,7 @@ "outDir": "./dist", "rootDir": "./src", "jsx": "react-jsx", - "tsBuildInfoFile": "./node_modules/.cache/tsc.tsbuildinfo" + "tsBuildInfoFile": "./dist/.tsbuildinfo" }, "include": ["src/**/*.ts", "src/**/*.tsx"], "exclude": ["dist", "node_modules"]