feat(setup): add Claude Desktop target and MCP-first agent setup (#114)
* feat(setup): add Claude Desktop target and MCP-first agent setup
Adds `ktx mcp stdio` and a `claude-desktop` setup target that generates a
local plugin ZIP wiring the analytics skill and a stdio MCP config. Replaces
the CLI-only agent install mode with MCP+analytics (default) and an optional
admin CLI skill, renames the research skill to analytics, and lets interactive
setup pick project vs global scope when every target supports it. Extracts a
shared MCP server factory used by both HTTP and stdio entrypoints.
* Add MCP agent client setup support
* Polish setup output formatting
* Add MCP tool polish design spec
Design for slimming the MCP-registered surface from 25 to 11 tools,
introducing memory_ingest, applying the per-tool polish kit (annotations,
outputSchema, .describe(), in-band error wrapping, union-drift fixes,
type-narrowed jsonToolResult), emitting progress notifications on
sql_execution + sl_query, and refining the ktx-analytics SKILL.md to
match.
* Refine MCP tool polish design spec after adversarial review iteration 1
* Refine MCP tool polish design spec after adversarial review iteration 2
* Refine MCP tool polish design spec after adversarial review iteration 3
* refactor(context): rename memory capture service to ingest
* feat(mcp): slim research tool surface
* refactor(mcp): remove admin ports from server factory
* refactor(cli): rename text ingest memory port
* docs: update analytics skill for memory ingest
* chore: verify mcp surface rename
* Add MCP tool polish v1 surface change plan
* feat(context): polish mcp tool metadata
* fix(context): enforce resolved semantic layer compute sources
* feat(context): emit mcp query progress stages
* fix(context): keep mcp progress event internal
* Add MCP tool polish v1 metadata & progress plan
* Fix CI snapshot and docs checks
2026-05-16 11:39:55 +02:00
|
|
|
import process from 'node:process';
|
|
|
|
|
import type { Readable, Writable } from 'node:stream';
|
|
|
|
|
import { loadKtxProject } from '@ktx/context/project';
|
|
|
|
|
import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
|
|
|
|
|
import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
|
|
|
|
|
import type { KtxCliIo } from './cli-runtime.js';
|
|
|
|
|
import { createKtxMcpServerFactory } from './mcp-server-factory.js';
|
|
|
|
|
|
|
|
|
|
export interface RunKtxMcpStdioServerOptions {
|
|
|
|
|
projectDir: string;
|
|
|
|
|
cliVersion?: string;
|
|
|
|
|
io?: KtxCliIo;
|
|
|
|
|
createMcpServer?: () => McpServer;
|
|
|
|
|
loadProject?: typeof loadKtxProject;
|
|
|
|
|
stdin?: Readable;
|
|
|
|
|
stdout?: Writable;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export async function runKtxMcpStdioServer(options: RunKtxMcpStdioServerOptions): Promise<void> {
|
|
|
|
|
const project =
|
|
|
|
|
options.createMcpServer === undefined
|
|
|
|
|
? await (options.loadProject ?? loadKtxProject)({ projectDir: options.projectDir })
|
|
|
|
|
: undefined;
|
|
|
|
|
const protocolIo: KtxCliIo = {
|
|
|
|
|
stdout: { write() {} },
|
2026-05-21 02:38:18 +02:00
|
|
|
stderr: options.io?.stderr ?? process.stderr,
|
feat(setup): add Claude Desktop target and MCP-first agent setup (#114)
* feat(setup): add Claude Desktop target and MCP-first agent setup
Adds `ktx mcp stdio` and a `claude-desktop` setup target that generates a
local plugin ZIP wiring the analytics skill and a stdio MCP config. Replaces
the CLI-only agent install mode with MCP+analytics (default) and an optional
admin CLI skill, renames the research skill to analytics, and lets interactive
setup pick project vs global scope when every target supports it. Extracts a
shared MCP server factory used by both HTTP and stdio entrypoints.
* Add MCP agent client setup support
* Polish setup output formatting
* Add MCP tool polish design spec
Design for slimming the MCP-registered surface from 25 to 11 tools,
introducing memory_ingest, applying the per-tool polish kit (annotations,
outputSchema, .describe(), in-band error wrapping, union-drift fixes,
type-narrowed jsonToolResult), emitting progress notifications on
sql_execution + sl_query, and refining the ktx-analytics SKILL.md to
match.
* Refine MCP tool polish design spec after adversarial review iteration 1
* Refine MCP tool polish design spec after adversarial review iteration 2
* Refine MCP tool polish design spec after adversarial review iteration 3
* refactor(context): rename memory capture service to ingest
* feat(mcp): slim research tool surface
* refactor(mcp): remove admin ports from server factory
* refactor(cli): rename text ingest memory port
* docs: update analytics skill for memory ingest
* chore: verify mcp surface rename
* Add MCP tool polish v1 surface change plan
* feat(context): polish mcp tool metadata
* fix(context): enforce resolved semantic layer compute sources
* feat(context): emit mcp query progress stages
* fix(context): keep mcp progress event internal
* Add MCP tool polish v1 metadata & progress plan
* Fix CI snapshot and docs checks
2026-05-16 11:39:55 +02:00
|
|
|
};
|
|
|
|
|
const createMcpServer =
|
|
|
|
|
options.createMcpServer ??
|
|
|
|
|
(await createKtxMcpServerFactory({
|
|
|
|
|
project: project!,
|
|
|
|
|
projectDir: options.projectDir,
|
|
|
|
|
cliVersion: options.cliVersion ?? '0.0.0-private',
|
|
|
|
|
io: protocolIo,
|
|
|
|
|
}));
|
|
|
|
|
const stdin = options.stdin ?? process.stdin;
|
|
|
|
|
const transport = new StdioServerTransport(stdin, options.stdout);
|
|
|
|
|
|
|
|
|
|
await new Promise<void>((resolve, reject) => {
|
|
|
|
|
let settled = false;
|
|
|
|
|
const settle = (callback: () => void) => {
|
|
|
|
|
if (settled) return;
|
|
|
|
|
settled = true;
|
|
|
|
|
stdin.off('end', closeTransport);
|
|
|
|
|
stdin.off('close', closeTransport);
|
|
|
|
|
callback();
|
|
|
|
|
};
|
|
|
|
|
const closeTransport = () => {
|
|
|
|
|
transport.close().catch((error: unknown) => {
|
|
|
|
|
settle(() => reject(error instanceof Error ? error : new Error(String(error))));
|
|
|
|
|
});
|
|
|
|
|
};
|
|
|
|
|
transport.onclose = () => settle(resolve);
|
|
|
|
|
transport.onerror = (error) => {
|
|
|
|
|
options.io?.stderr.write(`KTX MCP stdio transport error: ${error.message}\n`);
|
|
|
|
|
settle(() => reject(error));
|
|
|
|
|
};
|
|
|
|
|
stdin.once('end', closeTransport);
|
|
|
|
|
stdin.once('close', closeTransport);
|
|
|
|
|
createMcpServer().connect(transport).catch((error: unknown) => {
|
|
|
|
|
settle(() => reject(error instanceof Error ? error : new Error(String(error))));
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
}
|