mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
* 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
888 lines
32 KiB
TypeScript
888 lines
32 KiB
TypeScript
import { mkdir, mkdtemp, readFile, rm, stat, writeFile } from 'node:fs/promises';
|
|
import { tmpdir } from 'node:os';
|
|
import { join } from 'node:path';
|
|
import { readKtxSetupState } from '@ktx/context/project';
|
|
import { strFromU8, unzipSync } from 'fflate';
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
|
import {
|
|
formatInstallSummary,
|
|
plannedKtxAgentFiles,
|
|
readKtxAgentInstallManifest,
|
|
removeKtxAgentInstall,
|
|
runKtxSetupAgentsStep,
|
|
} from './setup-agents.js';
|
|
|
|
function makeIo() {
|
|
let stdout = '';
|
|
let stderr = '';
|
|
return {
|
|
io: {
|
|
stdout: { write: (chunk: string) => (stdout += chunk) },
|
|
stderr: { write: (chunk: string) => (stderr += chunk) },
|
|
},
|
|
stdout: () => stdout,
|
|
stderr: () => stderr,
|
|
};
|
|
}
|
|
|
|
async function readZipText(path: string, entry: string): Promise<string> {
|
|
const archive = unzipSync(new Uint8Array(await readFile(path)));
|
|
const content = archive[entry];
|
|
if (!content) throw new Error(`Missing zip entry: ${entry}`);
|
|
return strFromU8(content);
|
|
}
|
|
|
|
function captureEnvKeys(env: NodeJS.ProcessEnv, keys: readonly string[]): Record<string, string | undefined> {
|
|
const snapshot: Record<string, string | undefined> = {};
|
|
for (const key of keys) snapshot[key] = env[key];
|
|
return snapshot;
|
|
}
|
|
|
|
function clearEnvKeys(env: NodeJS.ProcessEnv, keys: readonly string[]): void {
|
|
for (const key of keys) delete env[key];
|
|
}
|
|
|
|
function captureKtxEnv(env: NodeJS.ProcessEnv): Record<string, string | undefined> {
|
|
const snapshot: Record<string, string | undefined> = {};
|
|
for (const key of Object.keys(env)) {
|
|
if (key.startsWith('KTX_')) snapshot[key] = env[key];
|
|
}
|
|
return snapshot;
|
|
}
|
|
|
|
function clearKtxEnv(env: NodeJS.ProcessEnv): void {
|
|
for (const key of Object.keys(env)) {
|
|
if (key.startsWith('KTX_')) delete env[key];
|
|
}
|
|
}
|
|
|
|
function restoreEnvKeys(env: NodeJS.ProcessEnv, snapshot: Record<string, string | undefined>): void {
|
|
for (const [key, value] of Object.entries(snapshot)) {
|
|
if (value === undefined) delete env[key];
|
|
else env[key] = value;
|
|
}
|
|
}
|
|
|
|
describe('setup agents', () => {
|
|
let tempDir: string;
|
|
|
|
beforeEach(async () => {
|
|
tempDir = await mkdtemp(join(tmpdir(), 'ktx-setup-agents-'));
|
|
await mkdir(join(tempDir, '.ktx', 'agents'), { recursive: true });
|
|
await writeFile(join(tempDir, 'ktx.yaml'), 'connections: {}\n', 'utf-8');
|
|
});
|
|
|
|
afterEach(async () => {
|
|
await rm(tempDir, { recursive: true, force: true });
|
|
});
|
|
|
|
it('plans project-scoped MCP analytics files for every target', () => {
|
|
expect(plannedKtxAgentFiles({ projectDir: tempDir, target: 'claude-code', scope: 'project', mode: 'mcp' })).toEqual([
|
|
{ kind: 'file', path: join(tempDir, '.claude/skills/ktx-analytics/SKILL.md'), role: 'analytics-skill' },
|
|
]);
|
|
expect(plannedKtxAgentFiles({ projectDir: tempDir, target: 'claude-desktop', scope: 'global', mode: 'mcp' })).toEqual([
|
|
{ kind: 'file', path: join(tempDir, '.ktx/agents/claude/ktx-plugin-runner.sh'), role: 'launcher' },
|
|
{ kind: 'file', path: join(tempDir, '.ktx/agents/claude/ktx-plugin.zip'), role: 'claude-plugin' },
|
|
]);
|
|
expect(plannedKtxAgentFiles({ projectDir: tempDir, target: 'codex', scope: 'project', mode: 'mcp' })).toEqual([
|
|
{ kind: 'file', path: join(tempDir, '.agents/skills/ktx-analytics/SKILL.md'), role: 'analytics-skill' },
|
|
]);
|
|
expect(plannedKtxAgentFiles({ projectDir: tempDir, target: 'cursor', scope: 'project', mode: 'mcp' })).toEqual([
|
|
{ kind: 'file', path: join(tempDir, '.cursor/rules/ktx-analytics.mdc'), role: 'analytics-skill' },
|
|
]);
|
|
expect(plannedKtxAgentFiles({ projectDir: tempDir, target: 'opencode', scope: 'project', mode: 'mcp' })).toEqual([
|
|
{ kind: 'file', path: join(tempDir, '.opencode/commands/ktx-analytics.md'), role: 'analytics-skill' },
|
|
]);
|
|
expect(plannedKtxAgentFiles({ projectDir: tempDir, target: 'universal', scope: 'project', mode: 'mcp' })).toEqual([
|
|
{ kind: 'file', path: join(tempDir, '.agents/skills/ktx-analytics/SKILL.md'), role: 'analytics-skill' },
|
|
]);
|
|
});
|
|
|
|
it('plans project-scoped admin CLI files for every target when requested', () => {
|
|
expect(plannedKtxAgentFiles({ projectDir: tempDir, target: 'claude-code', scope: 'project', mode: 'mcp-cli' })).toEqual([
|
|
{ kind: 'file', path: join(tempDir, '.claude/skills/ktx-analytics/SKILL.md'), role: 'analytics-skill' },
|
|
{ kind: 'file', path: join(tempDir, '.claude/skills/ktx/SKILL.md'), role: 'skill' },
|
|
{ kind: 'file', path: join(tempDir, '.claude/rules/ktx.md'), role: 'rule' },
|
|
]);
|
|
expect(plannedKtxAgentFiles({ projectDir: tempDir, target: 'codex', scope: 'project', mode: 'mcp-cli' })).toEqual([
|
|
{ kind: 'file', path: join(tempDir, '.agents/skills/ktx-analytics/SKILL.md'), role: 'analytics-skill' },
|
|
{ kind: 'file', path: join(tempDir, '.agents/skills/ktx/SKILL.md'), role: 'skill' },
|
|
{ kind: 'file', path: join(tempDir, '.codex/instructions/ktx.md'), role: 'rule' },
|
|
]);
|
|
expect(plannedKtxAgentFiles({ projectDir: tempDir, target: 'cursor', scope: 'project', mode: 'mcp-cli' })).toEqual([
|
|
{ kind: 'file', path: join(tempDir, '.cursor/rules/ktx-analytics.mdc'), role: 'analytics-skill' },
|
|
{ kind: 'file', path: join(tempDir, '.cursor/rules/ktx.mdc') },
|
|
]);
|
|
expect(plannedKtxAgentFiles({ projectDir: tempDir, target: 'opencode', scope: 'project', mode: 'mcp-cli' })).toEqual([
|
|
{ kind: 'file', path: join(tempDir, '.opencode/commands/ktx-analytics.md'), role: 'analytics-skill' },
|
|
{ kind: 'file', path: join(tempDir, '.opencode/commands/ktx.md') },
|
|
]);
|
|
expect(plannedKtxAgentFiles({ projectDir: tempDir, target: 'universal', scope: 'project', mode: 'mcp-cli' })).toEqual([
|
|
{ kind: 'file', path: join(tempDir, '.agents/skills/ktx-analytics/SKILL.md'), role: 'analytics-skill' },
|
|
{ kind: 'file', path: join(tempDir, '.agents/skills/ktx/SKILL.md') },
|
|
]);
|
|
expect(plannedKtxAgentFiles({ projectDir: tempDir, target: 'claude-desktop', scope: 'global', mode: 'mcp-cli' })).toEqual([
|
|
{ kind: 'file', path: join(tempDir, '.ktx/agents/claude/ktx-plugin-runner.sh'), role: 'launcher' },
|
|
{ kind: 'file', path: join(tempDir, '.ktx/agents/claude/ktx-plugin.zip'), role: 'claude-plugin' },
|
|
]);
|
|
});
|
|
|
|
it('installs target files, writes a manifest, and marks agents complete', async () => {
|
|
const io = makeIo();
|
|
|
|
await expect(
|
|
runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'disabled',
|
|
yes: true,
|
|
agents: true,
|
|
target: 'universal',
|
|
scope: 'project',
|
|
mode: 'mcp-cli',
|
|
skipAgents: false,
|
|
},
|
|
io.io,
|
|
),
|
|
).resolves.toEqual({
|
|
status: 'ready',
|
|
projectDir: tempDir,
|
|
installs: [{ target: 'universal', scope: 'project', mode: 'mcp-cli' }],
|
|
});
|
|
|
|
await expect(stat(join(tempDir, '.agents/skills/ktx/SKILL.md'))).resolves.toBeDefined();
|
|
const skill = await readFile(join(tempDir, '.agents/skills/ktx/SKILL.md'), 'utf-8');
|
|
expect(skill).toContain(`--project-dir ${tempDir}`);
|
|
expect(skill).toContain('must not print secrets');
|
|
expect(skill).toContain('status --json');
|
|
expect(skill).toContain('sl list --json');
|
|
expect(skill).toContain('sl query');
|
|
expect(skill).toContain('--format json');
|
|
expect(skill).not.toContain('sl query --json');
|
|
expect(skill).not.toContain('agent ');
|
|
expect(skill).not.toContain('sql execute');
|
|
expect(await readKtxAgentInstallManifest(tempDir)).toMatchObject({
|
|
version: 1,
|
|
projectDir: tempDir,
|
|
installs: [{ target: 'universal', scope: 'project', mode: 'mcp-cli' }],
|
|
});
|
|
expect(await readKtxSetupState(tempDir)).toEqual({ completed_steps: ['agents'] });
|
|
expect(io.stderr()).toBe('');
|
|
});
|
|
|
|
it('installs the analytics skill from the runtime asset', async () => {
|
|
const io = makeIo();
|
|
|
|
await expect(
|
|
runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'disabled',
|
|
yes: true,
|
|
agents: true,
|
|
target: 'universal',
|
|
scope: 'project',
|
|
mode: 'mcp-cli',
|
|
skipAgents: false,
|
|
},
|
|
io.io,
|
|
),
|
|
).resolves.toMatchObject({ status: 'ready' });
|
|
|
|
const analyticsSkill = await readFile(join(tempDir, '.agents/skills/ktx-analytics/SKILL.md'), 'utf-8');
|
|
expect(analyticsSkill).toContain('name: ktx-analytics');
|
|
expect(analyticsSkill).toContain('Always run `discover_data` before writing SQL.');
|
|
expect(analyticsSkill).toContain('Treat a `dictionary_search` miss as non-authoritative.');
|
|
expect(analyticsSkill).toContain('memory_ingest');
|
|
expect(analyticsSkill).toContain('ARR is reported in cents');
|
|
expect(analyticsSkill).not.toContain(`memory_${'capture'}`);
|
|
});
|
|
|
|
it('writes PATH-independent launcher commands for skills', async () => {
|
|
const io = makeIo();
|
|
|
|
await expect(
|
|
runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'disabled',
|
|
yes: true,
|
|
agents: true,
|
|
target: 'universal',
|
|
scope: 'project',
|
|
mode: 'mcp-cli',
|
|
skipAgents: false,
|
|
},
|
|
io.io,
|
|
),
|
|
).resolves.toMatchObject({ status: 'ready' });
|
|
|
|
const skill = await readFile(join(tempDir, '.agents/skills/ktx/SKILL.md'), 'utf-8');
|
|
expect(skill).not.toContain('`ktx agent');
|
|
expect(skill).toContain('status --json');
|
|
expect(skill).toContain('sl query');
|
|
expect(skill).toContain('--format json');
|
|
expect(skill).not.toContain('sl query --json');
|
|
expect(skill).not.toContain('sql execute');
|
|
});
|
|
|
|
it('writes Claude Code project MCP config and tracks the json key', async () => {
|
|
const io = makeIo();
|
|
|
|
await expect(
|
|
runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'disabled',
|
|
yes: true,
|
|
agents: true,
|
|
target: 'claude-code',
|
|
scope: 'project',
|
|
mode: 'mcp-cli',
|
|
skipAgents: false,
|
|
},
|
|
io.io,
|
|
),
|
|
).resolves.toMatchObject({ status: 'ready' });
|
|
|
|
const mcpJson = JSON.parse(await readFile(join(tempDir, '.mcp.json'), 'utf-8')) as {
|
|
mcpServers: { ktx: { type: string; url: string; headers?: Record<string, string> } };
|
|
};
|
|
expect(mcpJson.mcpServers.ktx).toEqual({ type: 'http', url: 'http://localhost:7878/mcp' });
|
|
expect(await readKtxAgentInstallManifest(tempDir)).toMatchObject({
|
|
entries: expect.arrayContaining([{ kind: 'json-key', path: join(tempDir, '.mcp.json'), jsonPath: ['mcpServers', 'ktx'] }]),
|
|
});
|
|
expect(io.stdout()).toContain('Run `ktx mcp start` to enable the configured KTX MCP server.');
|
|
});
|
|
|
|
it('prompts for MCP-first client agent connection mode in interactive setup', async () => {
|
|
const io = makeIo();
|
|
const prompts = {
|
|
select: vi.fn(async ({ message }: { message: string }) => (message.startsWith('Where') ? 'project' : 'mcp')),
|
|
multiselect: vi.fn(async () => ['claude-code']),
|
|
cancel: vi.fn(),
|
|
};
|
|
|
|
await expect(
|
|
runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'auto',
|
|
yes: false,
|
|
agents: true,
|
|
scope: 'project',
|
|
mode: 'mcp',
|
|
skipAgents: false,
|
|
},
|
|
io.io,
|
|
{ prompts },
|
|
),
|
|
).resolves.toMatchObject({
|
|
status: 'ready',
|
|
installs: [{ target: 'claude-code', scope: 'project', mode: 'mcp' }],
|
|
});
|
|
|
|
expect(prompts.select).toHaveBeenCalledWith({
|
|
message: 'How should client agents connect to this KTX project?',
|
|
options: [
|
|
{ value: 'mcp', label: 'MCP tools + analytics skill' },
|
|
{ value: 'mcp-cli', label: 'MCP tools + analytics skill + admin CLI skill' },
|
|
],
|
|
});
|
|
expect(prompts.multiselect).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
options: expect.arrayContaining([{ value: 'claude-desktop', label: 'Claude Desktop' }]),
|
|
}),
|
|
);
|
|
});
|
|
|
|
it('prompts for global scope when every selected target supports it', async () => {
|
|
const home = await mkdtemp(join(tmpdir(), 'ktx-setup-agents-home-'));
|
|
const previousHome = process.env.HOME;
|
|
process.env.HOME = home;
|
|
try {
|
|
const io = makeIo();
|
|
const prompts = {
|
|
select: vi.fn(async ({ message }: { message: string }) =>
|
|
message.startsWith('Where should') ? 'global' : 'mcp',
|
|
),
|
|
multiselect: vi.fn(async () => ['claude-code']),
|
|
cancel: vi.fn(),
|
|
};
|
|
|
|
await expect(
|
|
runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'auto',
|
|
yes: false,
|
|
agents: true,
|
|
scope: 'project',
|
|
mode: 'mcp',
|
|
skipAgents: false,
|
|
},
|
|
io.io,
|
|
{ prompts },
|
|
),
|
|
).resolves.toMatchObject({
|
|
status: 'ready',
|
|
installs: [{ target: 'claude-code', scope: 'global', mode: 'mcp' }],
|
|
});
|
|
|
|
expect(prompts.select).toHaveBeenCalledWith({
|
|
message: 'Where should KTX install supported agent config?',
|
|
options: [
|
|
{ value: 'project', label: 'Project' },
|
|
{ value: 'global', label: 'Global' },
|
|
],
|
|
});
|
|
} finally {
|
|
process.env.HOME = previousHome;
|
|
await rm(home, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
it('registers Claude Desktop MCP via claude_desktop_config.json and ships a skills-only plugin', async () => {
|
|
const home = await mkdtemp(join(tmpdir(), 'ktx-setup-agents-home-'));
|
|
const previousHome = process.env.HOME;
|
|
const envSnapshot = captureEnvKeys(process.env, ['OPENAI_API_KEY', 'ANTHROPIC_API_KEY']);
|
|
const ktxEnvSnapshot = captureKtxEnv(process.env);
|
|
process.env.HOME = home;
|
|
clearEnvKeys(process.env, ['OPENAI_API_KEY', 'ANTHROPIC_API_KEY']);
|
|
clearKtxEnv(process.env);
|
|
try {
|
|
const io = makeIo();
|
|
|
|
await expect(
|
|
runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'disabled',
|
|
yes: true,
|
|
agents: true,
|
|
target: 'claude-desktop',
|
|
scope: 'project',
|
|
mode: 'mcp',
|
|
skipAgents: false,
|
|
},
|
|
io.io,
|
|
),
|
|
).resolves.toMatchObject({
|
|
status: 'ready',
|
|
installs: [{ target: 'claude-desktop', scope: 'global', mode: 'mcp' }],
|
|
});
|
|
|
|
const pluginPath = join(tempDir, '.ktx/agents/claude/ktx-plugin.zip');
|
|
const launcherPath = join(tempDir, '.ktx/agents/claude/ktx-plugin-runner.sh');
|
|
await expect(stat(pluginPath)).resolves.toBeDefined();
|
|
const launcherStat = await stat(launcherPath);
|
|
expect(launcherStat.mode & 0o111).not.toBe(0);
|
|
const launcher = await readFile(launcherPath, 'utf-8');
|
|
expect(launcher).toContain('KTX_CLI_BIN=');
|
|
expect(launcher).toContain('.nvm/versions/node');
|
|
|
|
const configPath = join(home, 'Library/Application Support/Claude/claude_desktop_config.json');
|
|
const config = JSON.parse(await readFile(configPath, 'utf-8')) as {
|
|
mcpServers: { ktx: { command: string; args: string[]; env?: Record<string, string> } };
|
|
};
|
|
expect(config.mcpServers.ktx).toEqual({
|
|
command: launcherPath,
|
|
args: ['--project-dir', tempDir, 'mcp', 'stdio'],
|
|
});
|
|
|
|
expect(await readZipText(pluginPath, '.claude-plugin/plugin.json')).toContain('"name": "ktx"');
|
|
await expect(readZipText(pluginPath, '.mcp.json')).rejects.toThrow('Missing zip entry');
|
|
expect(await readZipText(pluginPath, 'skills/ktx-analytics/SKILL.md')).toContain('KTX Analytics Workflow');
|
|
const setupMd = await readZipText(pluginPath, 'SETUP.md');
|
|
expect(setupMd).not.toContain('ktx mcp start');
|
|
expect(setupMd).toContain('claude_desktop_config.json');
|
|
await expect(readZipText(pluginPath, 'skills/ktx/SKILL.md')).rejects.toThrow('Missing zip entry');
|
|
|
|
expect(io.stdout()).toContain('Claude plugin generated');
|
|
expect(io.stdout()).toContain('.ktx/agents/claude/ktx-plugin.zip');
|
|
expect(io.stdout()).toContain('KTX MCP server registered');
|
|
expect(io.stdout()).toContain('claude_desktop_config.json');
|
|
expect(io.stdout()).toContain('Restart Claude Desktop');
|
|
expect(io.stdout()).not.toContain('Run `ktx mcp start`');
|
|
} finally {
|
|
process.env.HOME = previousHome;
|
|
restoreEnvKeys(process.env, envSnapshot);
|
|
restoreEnvKeys(process.env, ktxEnvSnapshot);
|
|
await rm(home, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
it('captures KTX_*, OPENAI_API_KEY, and ANTHROPIC_API_KEY into the Claude Desktop MCP env block', async () => {
|
|
const home = await mkdtemp(join(tmpdir(), 'ktx-setup-agents-home-'));
|
|
const previousHome = process.env.HOME;
|
|
const envSnapshot = captureEnvKeys(process.env, [
|
|
'OPENAI_API_KEY',
|
|
'ANTHROPIC_API_KEY',
|
|
'KTX_LOG_LEVEL',
|
|
]);
|
|
const ktxEnvSnapshot = captureKtxEnv(process.env);
|
|
process.env.HOME = home;
|
|
clearKtxEnv(process.env);
|
|
process.env.OPENAI_API_KEY = 'sk-test-openai'; // pragma: allowlist secret
|
|
process.env.ANTHROPIC_API_KEY = 'sk-ant-test'; // pragma: allowlist secret
|
|
process.env.KTX_LOG_LEVEL = 'debug';
|
|
try {
|
|
const io = makeIo();
|
|
await runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'disabled',
|
|
yes: true,
|
|
agents: true,
|
|
target: 'claude-desktop',
|
|
scope: 'project',
|
|
mode: 'mcp',
|
|
skipAgents: false,
|
|
},
|
|
io.io,
|
|
);
|
|
|
|
const configPath = join(home, 'Library/Application Support/Claude/claude_desktop_config.json');
|
|
const config = JSON.parse(await readFile(configPath, 'utf-8')) as {
|
|
mcpServers: { ktx: { env?: Record<string, string> } };
|
|
};
|
|
expect(config.mcpServers.ktx.env).toEqual({
|
|
OPENAI_API_KEY: 'sk-test-openai', // pragma: allowlist secret
|
|
ANTHROPIC_API_KEY: 'sk-ant-test', // pragma: allowlist secret
|
|
KTX_LOG_LEVEL: 'debug',
|
|
});
|
|
} finally {
|
|
process.env.HOME = previousHome;
|
|
restoreEnvKeys(process.env, envSnapshot);
|
|
restoreEnvKeys(process.env, ktxEnvSnapshot);
|
|
await rm(home, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
it('includes the admin CLI skill in the Claude Desktop plugin zip when requested', async () => {
|
|
const home = await mkdtemp(join(tmpdir(), 'ktx-setup-agents-home-'));
|
|
const previousHome = process.env.HOME;
|
|
process.env.HOME = home;
|
|
try {
|
|
const io = makeIo();
|
|
|
|
await expect(
|
|
runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'disabled',
|
|
yes: true,
|
|
agents: true,
|
|
target: 'claude-desktop',
|
|
scope: 'project',
|
|
mode: 'mcp-cli',
|
|
skipAgents: false,
|
|
},
|
|
io.io,
|
|
),
|
|
).resolves.toMatchObject({
|
|
status: 'ready',
|
|
installs: [{ target: 'claude-desktop', scope: 'global', mode: 'mcp-cli' }],
|
|
});
|
|
|
|
const pluginPath = join(tempDir, '.ktx/agents/claude/ktx-plugin.zip');
|
|
const adminSkill = await readZipText(pluginPath, 'skills/ktx/SKILL.md');
|
|
expect(adminSkill).toContain(`--project-dir ${tempDir}`);
|
|
expect(adminSkill).toContain('status --json');
|
|
expect(await readZipText(pluginPath, 'SETUP.md')).toContain('admin CLI skill');
|
|
await expect(readZipText(pluginPath, '.mcp.json')).rejects.toThrow('Missing zip entry');
|
|
} finally {
|
|
process.env.HOME = previousHome;
|
|
await rm(home, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
it('installs MCP client config and analytics skill without admin CLI files', async () => {
|
|
const io = makeIo();
|
|
|
|
await expect(
|
|
runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'disabled',
|
|
yes: true,
|
|
agents: true,
|
|
target: 'claude-code',
|
|
scope: 'project',
|
|
mode: 'mcp',
|
|
skipAgents: false,
|
|
},
|
|
io.io,
|
|
),
|
|
).resolves.toMatchObject({
|
|
status: 'ready',
|
|
installs: [{ target: 'claude-code', scope: 'project', mode: 'mcp' }],
|
|
});
|
|
|
|
const mcpJson = JSON.parse(await readFile(join(tempDir, '.mcp.json'), 'utf-8')) as {
|
|
mcpServers: { ktx: { type: string; url: string } };
|
|
};
|
|
expect(mcpJson.mcpServers.ktx).toEqual({ type: 'http', url: 'http://localhost:7878/mcp' });
|
|
await expect(stat(join(tempDir, '.claude/skills/ktx-analytics/SKILL.md'))).resolves.toBeDefined();
|
|
await expect(stat(join(tempDir, '.claude/skills/ktx/SKILL.md'))).rejects.toThrow();
|
|
await expect(stat(join(tempDir, '.claude/rules/ktx.md'))).rejects.toThrow();
|
|
});
|
|
|
|
it('writes Cursor project MCP config', async () => {
|
|
const io = makeIo();
|
|
|
|
await runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'disabled',
|
|
yes: true,
|
|
agents: true,
|
|
target: 'cursor',
|
|
scope: 'project',
|
|
mode: 'mcp-cli',
|
|
skipAgents: false,
|
|
},
|
|
io.io,
|
|
);
|
|
|
|
const cursorJson = JSON.parse(await readFile(join(tempDir, '.cursor/mcp.json'), 'utf-8')) as {
|
|
mcpServers: { ktx: { url: string; headers?: Record<string, string> } };
|
|
};
|
|
expect(cursorJson.mcpServers.ktx).toEqual({ url: 'http://localhost:7878/mcp' });
|
|
});
|
|
|
|
it('prints Codex, opencode, and universal snippets without mutating printed-only config files', async () => {
|
|
const codexIo = makeIo();
|
|
await runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'disabled',
|
|
yes: true,
|
|
agents: true,
|
|
target: 'codex',
|
|
scope: 'project',
|
|
mode: 'mcp-cli',
|
|
skipAgents: false,
|
|
},
|
|
codexIo.io,
|
|
);
|
|
expect(codexIo.stdout()).toContain('[mcp_servers.ktx]');
|
|
expect(codexIo.stdout()).toContain('url = "http://localhost:7878/mcp"');
|
|
|
|
const opencodeIo = makeIo();
|
|
await runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'disabled',
|
|
yes: true,
|
|
agents: true,
|
|
target: 'opencode',
|
|
scope: 'project',
|
|
mode: 'mcp-cli',
|
|
skipAgents: false,
|
|
},
|
|
opencodeIo.io,
|
|
);
|
|
expect(opencodeIo.stdout()).toContain('"mcp"');
|
|
expect(opencodeIo.stdout()).toContain('"type": "remote"');
|
|
await expect(readFile(join(tempDir, 'opencode.json'), 'utf-8')).rejects.toThrow();
|
|
|
|
const universalIo = makeIo();
|
|
await runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'disabled',
|
|
yes: true,
|
|
agents: true,
|
|
target: 'universal',
|
|
scope: 'project',
|
|
mode: 'mcp',
|
|
skipAgents: false,
|
|
},
|
|
universalIo.io,
|
|
);
|
|
expect(universalIo.stdout()).toContain('Universal MCP endpoint:');
|
|
expect(universalIo.stdout()).toContain('http://localhost:7878/mcp');
|
|
});
|
|
|
|
it('uses MCP daemon state for port and token metadata without rendering literal tokens', async () => {
|
|
await mkdir(join(tempDir, '.ktx'), { recursive: true });
|
|
await writeFile(
|
|
join(tempDir, '.ktx/mcp.json'),
|
|
`${JSON.stringify(
|
|
{
|
|
schemaVersion: 1,
|
|
pid: 999999,
|
|
host: '127.0.0.1',
|
|
port: 8787,
|
|
tokenAuth: true,
|
|
projectDir: tempDir,
|
|
startedAt: '2026-05-14T00:00:00.000Z',
|
|
logPath: join(tempDir, '.ktx/logs/mcp.log'),
|
|
},
|
|
null,
|
|
2,
|
|
)}\n`,
|
|
'utf-8',
|
|
);
|
|
const io = makeIo();
|
|
const previousToken = process.env.KTX_MCP_TOKEN;
|
|
process.env.KTX_MCP_TOKEN = 'secret-token';
|
|
|
|
try {
|
|
await runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'disabled',
|
|
yes: true,
|
|
agents: true,
|
|
target: 'claude-code',
|
|
scope: 'project',
|
|
mode: 'mcp-cli',
|
|
skipAgents: false,
|
|
},
|
|
io.io,
|
|
);
|
|
|
|
const rendered = JSON.stringify(JSON.parse(await readFile(join(tempDir, '.mcp.json'), 'utf-8')));
|
|
expect(rendered).toContain('http://127.0.0.1:8787/mcp');
|
|
expect(rendered).toContain('Bearer ${KTX_MCP_TOKEN}');
|
|
expect(rendered).not.toContain('secret-token');
|
|
expect(io.stdout()).toContain('Run `ktx mcp start` to enable the configured KTX MCP server.');
|
|
} finally {
|
|
if (previousToken === undefined) {
|
|
delete process.env.KTX_MCP_TOKEN;
|
|
} else {
|
|
process.env.KTX_MCP_TOKEN = previousToken;
|
|
}
|
|
}
|
|
});
|
|
|
|
it('writes Claude Code local MCP config under the project key in ~/.claude.json', async () => {
|
|
const home = await mkdtemp(join(tmpdir(), 'ktx-setup-agents-home-'));
|
|
const previousHome = process.env.HOME;
|
|
process.env.HOME = home;
|
|
try {
|
|
const io = makeIo();
|
|
await runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'disabled',
|
|
yes: true,
|
|
agents: true,
|
|
target: 'claude-code',
|
|
scope: 'local',
|
|
mode: 'mcp-cli',
|
|
skipAgents: false,
|
|
},
|
|
io.io,
|
|
);
|
|
|
|
const config = JSON.parse(await readFile(join(home, '.claude.json'), 'utf-8')) as {
|
|
projects: Record<string, { mcpServers: { ktx: { type: string; url: string } } }>;
|
|
};
|
|
expect(config.projects[tempDir].mcpServers.ktx).toEqual({ type: 'http', url: 'http://localhost:7878/mcp' });
|
|
} finally {
|
|
process.env.HOME = previousHome;
|
|
await rm(home, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
it('removes only manifest-listed files', async () => {
|
|
const io = makeIo();
|
|
await runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'disabled',
|
|
yes: true,
|
|
agents: true,
|
|
target: 'claude-code',
|
|
scope: 'project',
|
|
mode: 'mcp-cli',
|
|
skipAgents: false,
|
|
},
|
|
io.io,
|
|
);
|
|
await writeFile(join(tempDir, '.claude/skills/ktx/keep.txt'), 'user file', 'utf-8');
|
|
|
|
await expect(removeKtxAgentInstall(tempDir, io.io)).resolves.toBe(0);
|
|
|
|
await expect(stat(join(tempDir, '.claude/skills/ktx/SKILL.md'))).rejects.toThrow();
|
|
await expect(stat(join(tempDir, '.claude/rules/ktx.md'))).rejects.toThrow();
|
|
await expect(stat(join(tempDir, '.claude/skills/ktx/keep.txt'))).resolves.toBeDefined();
|
|
await expect(readKtxAgentInstallManifest(tempDir)).resolves.toEqual(null);
|
|
});
|
|
|
|
it('removes generated Claude Desktop plugin from the manifest', async () => {
|
|
const home = await mkdtemp(join(tmpdir(), 'ktx-setup-agents-home-'));
|
|
const previousHome = process.env.HOME;
|
|
process.env.HOME = home;
|
|
try {
|
|
const io = makeIo();
|
|
await runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'disabled',
|
|
yes: true,
|
|
agents: true,
|
|
target: 'claude-desktop',
|
|
scope: 'project',
|
|
mode: 'mcp-cli',
|
|
skipAgents: false,
|
|
},
|
|
io.io,
|
|
);
|
|
const pluginPath = join(tempDir, '.ktx/agents/claude/ktx-plugin.zip');
|
|
const launcherPath = join(tempDir, '.ktx/agents/claude/ktx-plugin-runner.sh');
|
|
const configPath = join(home, 'Library/Application Support/Claude/claude_desktop_config.json');
|
|
await expect(stat(pluginPath)).resolves.toBeDefined();
|
|
await expect(stat(launcherPath)).resolves.toBeDefined();
|
|
const beforeConfig = JSON.parse(await readFile(configPath, 'utf-8')) as {
|
|
mcpServers: Record<string, unknown>;
|
|
};
|
|
expect(beforeConfig.mcpServers.ktx).toBeDefined();
|
|
|
|
await expect(removeKtxAgentInstall(tempDir, io.io)).resolves.toBe(0);
|
|
|
|
await expect(stat(pluginPath)).rejects.toThrow();
|
|
await expect(stat(launcherPath)).rejects.toThrow();
|
|
const afterConfig = JSON.parse(await readFile(configPath, 'utf-8')) as {
|
|
mcpServers: Record<string, unknown>;
|
|
};
|
|
expect(afterConfig.mcpServers.ktx).toBeUndefined();
|
|
await expect(readKtxAgentInstallManifest(tempDir)).resolves.toEqual(null);
|
|
} finally {
|
|
process.env.HOME = previousHome;
|
|
await rm(home, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
it('treats cancel as skip in interactive mode', async () => {
|
|
const io = makeIo();
|
|
const prompts = {
|
|
select: vi.fn(async () => 'back'),
|
|
multiselect: vi.fn(async () => ['codex']),
|
|
cancel: vi.fn(),
|
|
};
|
|
|
|
await expect(
|
|
runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'auto',
|
|
yes: false,
|
|
agents: true,
|
|
scope: 'project',
|
|
mode: 'mcp-cli',
|
|
skipAgents: false,
|
|
},
|
|
io.io,
|
|
{ prompts },
|
|
),
|
|
).resolves.toEqual({ status: 'skipped', projectDir: tempDir });
|
|
});
|
|
|
|
it('explains how to select multiple agent targets in interactive mode', async () => {
|
|
const io = makeIo();
|
|
const prompts = {
|
|
select: vi.fn(async () => 'mcp-cli'),
|
|
multiselect: vi.fn(async () => ['back']),
|
|
cancel: vi.fn(),
|
|
};
|
|
|
|
await expect(
|
|
runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'auto',
|
|
yes: false,
|
|
agents: true,
|
|
scope: 'project',
|
|
mode: 'mcp-cli',
|
|
skipAgents: false,
|
|
},
|
|
io.io,
|
|
{ prompts },
|
|
),
|
|
).resolves.toEqual({ status: 'back', projectDir: tempDir });
|
|
|
|
expect(prompts.multiselect).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
message:
|
|
'Which agent targets should KTX install?\nUse Up/Down to move, Space to select or unselect, Enter to confirm, Escape to go back, or Ctrl+C to exit.',
|
|
}),
|
|
);
|
|
});
|
|
|
|
it('prints per-agent install summary after successful installation', async () => {
|
|
const io = makeIo();
|
|
|
|
await runKtxSetupAgentsStep(
|
|
{
|
|
projectDir: tempDir,
|
|
inputMode: 'disabled',
|
|
yes: true,
|
|
agents: true,
|
|
target: 'claude-code',
|
|
scope: 'project',
|
|
mode: 'mcp-cli',
|
|
skipAgents: false,
|
|
},
|
|
io.io,
|
|
);
|
|
|
|
const output = io.stdout();
|
|
expect(output).toContain('Agent integration complete');
|
|
expect(output).toContain('Claude Code');
|
|
expect(output).toContain('+ Analytics skill installed — teaches your agent the KTX MCP analytics workflow');
|
|
expect(output).toContain('.claude/skills/ktx-analytics/SKILL.md');
|
|
expect(output).toContain('+ Skill installed — teaches admin agents which KTX CLI commands to run');
|
|
expect(output).toContain('.claude/skills/ktx/SKILL.md');
|
|
expect(output).toContain('+ Rule installed — tells admin agents when to use KTX CLI');
|
|
expect(output).toContain('.claude/rules/ktx.md');
|
|
});
|
|
|
|
it('formats summary with relative paths for project scope', () => {
|
|
const summary = formatInstallSummary(
|
|
[{ target: 'cursor', scope: 'project', mode: 'mcp-cli' }],
|
|
[
|
|
{ kind: 'file', path: join(tempDir, '.cursor/rules/ktx-analytics.mdc'), role: 'analytics-skill' },
|
|
{ kind: 'file', path: join(tempDir, '.cursor/rules/ktx.mdc') },
|
|
],
|
|
tempDir,
|
|
);
|
|
|
|
expect(summary).toContain('Cursor');
|
|
expect(summary).toContain('+ Analytics skill installed — teaches your agent the KTX MCP analytics workflow');
|
|
expect(summary).toContain('.cursor/rules/ktx-analytics.mdc');
|
|
expect(summary).toContain('+ Rule installed — tells admin agents when to use KTX CLI');
|
|
expect(summary).toContain('.cursor/rules/ktx.mdc');
|
|
expect(summary).not.toContain(tempDir);
|
|
});
|
|
|
|
it('formats summary with multiple agent targets', () => {
|
|
const summary = formatInstallSummary(
|
|
[
|
|
{ target: 'claude-code', scope: 'project', mode: 'mcp-cli' },
|
|
{ target: 'codex', scope: 'project', mode: 'mcp-cli' },
|
|
],
|
|
[
|
|
{ kind: 'file', path: join(tempDir, '.claude/skills/ktx-analytics/SKILL.md'), role: 'analytics-skill' },
|
|
{ kind: 'file', path: join(tempDir, '.claude/skills/ktx/SKILL.md'), role: 'skill' },
|
|
{ kind: 'file', path: join(tempDir, '.claude/rules/ktx.md'), role: 'rule' },
|
|
{ kind: 'file', path: join(tempDir, '.agents/skills/ktx-analytics/SKILL.md'), role: 'analytics-skill' },
|
|
{ kind: 'file', path: join(tempDir, '.agents/skills/ktx/SKILL.md'), role: 'skill' },
|
|
{ kind: 'file', path: join(tempDir, '.codex/instructions/ktx.md'), role: 'rule' },
|
|
],
|
|
tempDir,
|
|
);
|
|
|
|
expect(summary).toContain('Claude Code');
|
|
expect(summary).toContain('+ Analytics skill installed — teaches your agent the KTX MCP analytics workflow');
|
|
expect(summary).toContain('+ Skill installed — teaches admin agents which KTX CLI commands to run');
|
|
expect(summary).toContain('+ Rule installed — tells admin agents when to use KTX CLI');
|
|
expect(summary).toContain('Codex');
|
|
expect(summary).toContain('.agents/skills/ktx-analytics/SKILL.md');
|
|
expect(summary).toContain('.agents/skills/ktx/SKILL.md');
|
|
});
|
|
});
|