Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

3.7 KB
Raw Blame
import { OK_GATED_TOOL_NAMES, OPEN_KNOWLEDGE_MCP_TOOLS } from '@inkeep/open-knowledge-core';
import { afterAll, describe, expect, test } from 'vitest';
import { createTempDirFactory } from '../../../../../test-support/temp-dir.test-helper.ts';
import { type Config, ConfigSchema } from '../../config/schema.ts';
import { registerAllTools } from './index.ts';
import type { ServerInstance } from './shared.ts';

const makeTempDir = createTempDirFactory(afterAll);

const BASE_CONFIG: Config = ConfigSchema.parse({});

const EXPECTED_TOOLS = OPEN_KNOWLEDGE_MCP_TOOLS;

const RETIRED_TOOL_NAMES = [
  'conflicts',
  'resolve_conflict',
  'graph_view',
  'get_backlinks',
  'get_forward_links',
  'get_dead_links',
  'get_orphans',
  'get_hubs',
  'suggest_links',
  'rename_document',
  'rename_folder',
  'save_version',
  'rollback_to_version',
  'version',
  'set_folder_rule',
  'write_template',
  'delete_template',
  'frontmatter_patch',
  'write_document',
  'edit_document',
  'edit_frontmatter',
  'delete_document',
  'rename',
  'folder_config',
  'read_document',
  'grep',
  'list_documents',
  'get_components',
  'get_authoring_palette',
  'ingest',
  'research',
  'consolidate',
  'discover',
  'workflow',
  'get_history',
  'get_config',
  'get_preview_url',
] as const;

function captureRegistered(): string[] {
  const names: string[] = [];
  const cwd = makeTempDir('ok-registry-assertion-');
  const server = {
    registerTool(name: string, _cfg: unknown, _handler: unknown) {
      names.push(name);
    },
    tool() {
      throw new Error('legacy tool() API not expected — every tool must use registerTool');
    },
  } as unknown as ServerInstance;
  registerAllTools(server, {
    config: BASE_CONFIG,
    resolveCwd: async () => cwd,
    serverUrl: undefined,
  });
  return names;
}

describe('registerAllTools — full tool surface (SPEC.md §9.1 / AC8 + install + skills + lint + audit)', () => {
  test('registers exactly the expected number of tools', () => {
    const names = captureRegistered();
    expect(names.length).toBe(EXPECTED_TOOLS.length);
  });

  test('the expected tool names are all present', () => {
    const names = new Set(captureRegistered());
    for (const expected of EXPECTED_TOOLS) {
      expect(names).toContain(expected);
    }
  });

  test('none of the retired tool names are registered', () => {
    const names = new Set(captureRegistered());
    for (const retired of RETIRED_TOOL_NAMES) {
      expect(names.has(retired)).toBe(false);
    }
  });

  test('the registered set matches the expected set exactly (no extras)', () => {
    const names = new Set(captureRegistered());
    expect(names).toEqual(new Set(EXPECTED_TOOLS));
  });

  test('no duplicate registrations', () => {
    const names = captureRegistered();
    expect(names.length).toBe(new Set(names).size);
  });
});

const OK_AUTO_APPROVED_TOOLS = [
  'exec',
  'search',
  'history',
  'links',
  'skills',
  'config',
  'palette',
  'preview_url',
  'write',
  'edit',
  'checkpoint',
  'restore_version',
  'lint',
  'audit',
] as const;

describe('docked-terminal auto-approve classification', () => {
  test('every registered tool is classified as gated or auto-approved', () => {
    expect(new Set([...OK_AUTO_APPROVED_TOOLS, ...OK_GATED_TOOL_NAMES])).toEqual(
      new Set(captureRegistered()),
    );
  });

  test('no tool is both gated and auto-approved', () => {
    const gated = new Set<string>(OK_GATED_TOOL_NAMES);
    expect(OK_AUTO_APPROVED_TOOLS.filter((name) => gated.has(name))).toEqual([]);
  });

  test('the ask-list only names tools that actually exist', () => {
    const registered = new Set(captureRegistered());
    for (const gated of OK_GATED_TOOL_NAMES) {
      expect(registered).toContain(gated);
    }
  });
});