char-fork/llama.cpp

git clone https://git.t4t.associates/char-fork/llama.cpp

Aleksander Grygierui: Replace per-conversation MCP overrides with per-conversation tool policy (#27745)fe235f4342026-08-27

/**
 * toolsStore - Tool registry and enablement
 *
 * Owns the server tool listing (with working-directory resolution), built-in
 * browser tools, MCP tools and per-tool enablement, exposed as a unified
 * tool set for the LLM and the tools UI. Consumed by the agentic loop and
 * the chat flows.
 */

import { browser } from '$app/environment';
import {
	buildBrowserInfoToolDefinition,
	buildGetDatetimeToolDefinition,
	buildReadMediaToolDefinition,
	DISABLED_TOOL_CATEGORIES_LOCALSTORAGE_KEY,
	DISABLED_TOOL_KEYS_LOCALSTORAGE_KEY,
	HOME_TILDE,
	TOOL_GROUP_LABELS,
	TOOL_SERVER_LABELS
} from '$lib/constants';
import {
	BuiltInTool,
	GlobSearchType,
	HealthCheckStatus,
	JsonSchemaType,
	ToolCallType,
	ToolSource
} from '$lib/enums';
import { ToolsService } from '$lib/services/tools.service';
// direct imports between stores, not via the barrel, to avoid circular deps
import { mcpStore } from '$lib/stores/mcp/index.svelte';
import { modelsStore } from '$lib/stores/models/index.svelte';
import { settingsStore } from '$lib/stores/settings/index.svelte';
import type { OpenAIToolDefinition, ToolEntry, ToolGroup } from '$lib/types';
import { buildSandboxToolDefinition } from '$lib/utils';
import { SvelteMap, SvelteSet } from 'svelte/reactivity';

/** Stable selection identity for a tool, shared by the disabled set and the permission store */

class ToolsStore {
	// default disabled tool categories, seeded into newly created conversations;
	// the per-conversation policy lives on the conversation row
	private _disabledToolCategories = $state(new SvelteSet<ToolSource>());
	private _disabledTools = $state(new SvelteSet<string>());
	private _error = $state<string | null>(null);
	private _loading = $state(false);
	private _serverHome = $state<string | null | undefined>(undefined);
	private _serverTools = $state<OpenAIToolDefinition[]>([]);
	private _toolsEndpointUnreachable = $state(false);
	// server tools that resolve their paths against the working directory,
	// as declared by the server in its `/tools` listing
	private cwdAwareTools = $state(new SvelteSet<string>());

	get allToolDefinitions(): OpenAIToolDefinition[] {
		return this.allTools.map((t) => t.definition);
	}

	/** Canonical flat list of tool entries with source metadata and stable keys, deduped by key */
	get allTools(): ToolEntry[] {
		const entries: ToolEntry[] = [];
		const seen = new SvelteSet<string>();
		const push = (entry: ToolEntry) => {
			if (seen.has(entry.key)) return;

			seen.add(entry.key);
			entries.push(entry);
		};

		for (const def of this._serverTools) {
			const name = def.function.name;

			push({
				definition: def,
				key: this.toolKey(ToolSource.SERVER, name),
				source: ToolSource.SERVER
			});
		}

		for (const def of this.browserTools) {
			const name = def.function.name;

			push({
				definition: def,
				key: this.toolKey(ToolSource.BROWSER, name),
				source: ToolSource.BROWSER
			});
		}

		for (const { definition, serverId, serverName } of this.mcpEntries()) {
			const name = definition.function.name;

			push({
				definition,
				key: this.toolKey(ToolSource.MCP, name, serverId),
				serverId,
				serverName,
				source: ToolSource.MCP
			});
		}

		for (const def of this.customTools) {
			const name = def.function.name;

			push({
				definition: def,
				key: this.toolKey(ToolSource.CUSTOM, name),
				source: ToolSource.CUSTOM
			});
		}

		return entries;
	}

	get browserTools(): OpenAIToolDefinition[] {
		const tools: OpenAIToolDefinition[] = [buildGetDatetimeToolDefinition()];

		if (settingsStore.config.jsSandboxEnabled) {
			tools.push(buildSandboxToolDefinition(!!settingsStore.config.symbolicMathEnabled));
		}

		const readMedia = this.readMediaTool();

		if (readMedia) tools.push(readMedia);

		// provide browser's get_info tool if server doesn't provide one
		if (!this.hasServerTool(BuiltInTool.SERVER_GET_INFO)) {
			tools.push(buildBrowserInfoToolDefinition());
		}

		return tools;
	}

	get customTools(): OpenAIToolDefinition[] {
		const raw = settingsStore.config.customJson;

		if (!raw || typeof raw !== 'string') return [];

		try {
			const parsed = JSON.parse(raw);

			if (!Array.isArray(parsed)) return [];

			return parsed.filter(
				(t: unknown): t is OpenAIToolDefinition =>
					typeof t === 'object' &&
					t !== null &&
					'type' in t &&
					(t as OpenAIToolDefinition).type === 'function' &&
					'function' in t &&
					typeof (t as OpenAIToolDefinition).function?.name === 'string'
			);
		} catch {
			return [];
		}
	}

	get disabledToolCategories(): ReadonlySet<ToolSource> {
		return this._disabledToolCategories;
	}

	get disabledTools(): SvelteSet<string> {
		return this._disabledTools;
	}

	get error(): string | null {
		return this._error;
	}

	get isToolsEndpointUnreachable(): boolean {
		return this._toolsEndpointUnreachable;
	}

	get loading(): boolean {
		return this._loading;
	}

	get mcpTools(): OpenAIToolDefinition[] {
		return this.mcpEntries().map((e) => e.definition);
	}

	get serverHome(): string | null {
		return this._serverHome ?? null;
	}

	get serverTools(): OpenAIToolDefinition[] {
		return this._serverTools;
	}

	/** Tools grouped by category for tree display, derived from the canonical entries */
	get toolGroups(): ToolGroup[] {
		const groups: ToolGroup[] = [];
		const byKey = new SvelteMap<string, ToolGroup>();

		for (const entry of this.allTools) {
			const groupKey =
				entry.source === ToolSource.MCP ? `mcp:${entry.serverId ?? ''}` : entry.source;

			let group = byKey.get(groupKey);

			if (!group) {
				group = {
					key: groupKey,
					label: this.groupLabel(entry),
					serverId: entry.serverId,
					source: entry.source,
					tools: []
				};
				byKey.set(groupKey, group);
				groups.push(group);
			}

			group.tools.push(entry);
		}

		return groups;
	}

	/** Enable all tools belonging to a specific MCP server */
	enableAllToolsForServer(serverId: string): void {
		const connection = mcpStore.getConnections().get(serverId);

		if (!connection) return;

		// the server-scoped group key disables every tool regardless of per-tool keys
		this._disabledTools.delete(this.getMcpServerToolsKey(serverId));

		for (const tool of connection.tools) {
			this._disabledTools.delete(this.toolKey(ToolSource.MCP, tool.name, serverId));
		}

		this.persistDisabledTools();
	}

	async fetchServerTools(): Promise<void> {
		if (this._loading) return;

		this._loading = true;
		this._error = null;
		this._toolsEndpointUnreachable = false;

		try {
			const toolInfos = await ToolsService.list();

			this._serverTools = toolInfos.map((info) => info.definition);
			this.cwdAwareTools = new SvelteSet(
				toolInfos.filter((info) => info.uses_cwd).map((info) => info.tool)
			);
		} catch (err) {
			const errorMessage = err instanceof Error ? err.message : String(err);

			this._error = errorMessage;

			// 403 from /tools means the server was started without --tools
			// TODO: check status code instead of relying on message
			if (errorMessage.includes('this feature is disabled')) {
				this._toolsEndpointUnreachable = true;
				console.info('[ToolsStore] Server tools are disabled on the server');
			} else {
				console.error('[ToolsStore] Failed to fetch server tools:', err);
			}
		} finally {
			this._loading = false;
		}
	}

	/**
	 * Enabled tool definitions for sending to the LLM. Callers pass an
	 * explicit policy (the active conversation's, resolved with global
	 * defaults when absent); without arguments the store defaults apply.
	 * MCP tool schemas are normalized here so the wire payload is consistent
	 * across all four sources (server, browser/sandbox, MCP, custom JSON).
	 * The API identifies tools by name, so a name is sent at most once.
	 */
	getEnabledToolsForLLM(
		disabledTools: ReadonlySet<string> = this._disabledTools,
		disabledCategories: ReadonlySet<ToolSource> = this._disabledToolCategories
	): OpenAIToolDefinition[] {
		const enabledNames = new SvelteSet<string>();

		for (const entry of this.allTools) {
			if (this.isEntryEnabled(entry, disabledTools, disabledCategories)) {
				enabledNames.add(entry.definition.function.name);
			}
		}

		const result: OpenAIToolDefinition[] = [];
		const seen = new SvelteSet<string>();
		const take = (def: OpenAIToolDefinition) => {
			const name = def.function.name;

			if (!enabledNames.has(name) || seen.has(name)) return;

			seen.add(name);
			result.push(def);
		};

		for (const def of this._serverTools) take(def);
		for (const def of this.browserTools) take(def);
		// mcpEntries() over mcpStore directly so wire shape stays normalized and aligned with the tools UI.
		for (const entry of this.mcpEntries()) take(entry.definition);
		for (const def of this.customTools) take(def);

		return result;
	}

	/** Server-scoped tool key: disabling it disables all of that server's tools. */
	getMcpServerToolsKey(serverId: string): string {
		return `mcp:${serverId}`;
	}

	/** Permission key for a tool name, identical to the selection key */
	getPermissionKey(toolName: string): string | null {
		return this.findEntryByName(toolName)?.key ?? null;
	}

	/** Get the display label for the server that owns a given tool */
	getToolServerLabel(toolName: string): string {
		const entry = this.findEntryByName(toolName);

		if (!entry) return '';

		if (entry.serverName) return mcpStore.getServerDisplayName(entry.serverName);

		if (entry.source === ToolSource.SERVER) return TOOL_SERVER_LABELS[ToolSource.SERVER];

		if (entry.source === ToolSource.CUSTOM) return TOOL_SERVER_LABELS[ToolSource.CUSTOM];

		if (entry.source === ToolSource.BROWSER) return TOOL_SERVER_LABELS[ToolSource.BROWSER];

		return '';
	}

	/** Determine the source of a tool by its name */
	getToolSource(toolName: string): ToolSource | null {
		return this.findEntryByName(toolName)?.source ?? null;
	}

	/**
	 * Check if a working directory is worth setting: at least one server tool
	 * that reads it is both served and left enabled by the given policy
	 * (defaults to the global defaults).
	 */
	hasEnabledCwdTools(
		disabledTools: ReadonlySet<string> = this._disabledTools,
		disabledCategories: ReadonlySet<ToolSource> = this._disabledToolCategories
	): boolean {
		if (disabledCategories.has(ToolSource.SERVER)) return false;

		return this._serverTools.some((def) => {
			const name = def.function.name;

			return (
				this.cwdAwareTools.has(name) && !disabledTools.has(this.toolKey(ToolSource.SERVER, name))
			);
		});
	}

	/**
	 * Load persisted disabled tools and fetch the builtin tool list.
	 * Called by initStores() after migrations have run.
	 */
	initialize(): void {
		// browser-only init: skip on SSR to avoid localStorage/fetch side effects
		if (!browser) return;

		try {
			const stored = localStorage.getItem(DISABLED_TOOL_KEYS_LOCALSTORAGE_KEY);

			if (stored) {
				const parsed = JSON.parse(stored);

				if (Array.isArray(parsed)) {
					for (const key of parsed) {
						if (typeof key === 'string') this._disabledTools.add(key);
					}
				}
			}
		} catch (err) {
			console.error('[ToolsStore] Failed to load disabled tools from localStorage:', err);
		}

		try {
			const stored = localStorage.getItem(DISABLED_TOOL_CATEGORIES_LOCALSTORAGE_KEY);

			if (stored) {
				const parsed = JSON.parse(stored);

				if (Array.isArray(parsed)) {
					for (const key of parsed) {
						if (Object.values(ToolSource).includes(key)) {
							this._disabledToolCategories.add(key as ToolSource);
						}
					}
				}
			}
		} catch (err) {
			console.error('[ToolsStore] Failed to load disabled tool categories from localStorage:', err);
		}

		this.fetchServerTools();
	}

	isCategoryEnabled(source: ToolSource): boolean {
		return !this._disabledToolCategories.has(source);
	}

	isEntryEnabled(
		entry: ToolEntry,
		disabledTools: ReadonlySet<string>,
		disabledCategories: ReadonlySet<ToolSource>
	): boolean {
		if (disabledCategories.has(entry.source)) return false;

		if (disabledTools.has(entry.key)) return false;

		if (entry.source === ToolSource.MCP && entry.serverId) {
			return !disabledTools.has(this.getMcpServerToolsKey(entry.serverId));
		}

		return true;
	}

	isToolEnabled(key: string): boolean {
		return !this._disabledTools.has(key);
	}

	/**
	 * Absolute home directory on the server, resolved once per session via
	 * file_glob_search's `base` field (the server expands `~`). Anchors the
	 * directory picker's search scope and the `~` abbreviation of cwd
	 * displays. Returns null when tools are unavailable.
	 */
	async resolveServerHome(): Promise<string | null> {
		if (this._serverHome !== undefined) return this._serverHome;

		try {
			const res = await ToolsService.executeToolRaw(BuiltInTool.SERVER_FILE_GLOB_SEARCH, {
				limit: 1,
				max_depth: 1,
				path: HOME_TILDE,
				type: GlobSearchType.DIR
			});

			this._serverHome = typeof res.base === 'string' ? res.base : null;
		} catch {
			// searches still work via a literal `~`, only `~` abbreviation degrades
			this._serverHome = null;
		}

		return this._serverHome;
	}

	setCategoryEnabled(source: ToolSource, enabled: boolean): void {
		if (enabled) {
			this._disabledToolCategories.delete(source);
		} else {
			this._disabledToolCategories.add(source);
		}

		this.persistDisabledToolCategories();
	}

	setToolEnabled(key: string, enabled: boolean): void {
		if (enabled) {
			this._disabledTools.delete(key);
		} else {
			this._disabledTools.add(key);
		}

		this.persistDisabledTools();
	}

	toggleCategory(source: ToolSource): void {
		this.setCategoryEnabled(source, !this.isCategoryEnabled(source));
	}

	toggleTool(key: string): void {
		this.setToolEnabled(key, !this.isToolEnabled(key));
	}

	/** First canonical entry matching a tool name, runtime tool calls resolve by name */
	private findEntryByName(toolName: string): ToolEntry | null {
		for (const entry of this.allTools) {
			if (entry.definition.function.name === toolName) return entry;
		}

		return null;
	}

	/** Get MCP tools from health check data, used when live connections aren't established yet */
	private getMcpToolsFromHealthChecks(): {
		serverId: string;
		serverName: string;
		tools: { name: string; description?: string }[];
	}[] {
		const result: ReturnType<ToolsStore['getMcpToolsFromHealthChecks']> = [];

		for (const server of mcpStore.getServers()) {
			if (!server.enabled) continue;

			const health = mcpStore.getHealthCheckState(server.id);

			if (health.status === HealthCheckStatus.SUCCESS && health.tools.length > 0) {
				result.push({
					serverId: server.id,
					serverName: mcpStore.getServerLabel(server),
					tools: health.tools
				});
			}
		}

		return result;
	}

	private groupLabel(entry: ToolEntry): string {
		switch (entry.source) {
			case ToolSource.MCP:
				return entry.serverName ?? '';
			case ToolSource.CUSTOM:
				return TOOL_GROUP_LABELS[ToolSource.CUSTOM];
			case ToolSource.BROWSER:
				return TOOL_GROUP_LABELS[ToolSource.BROWSER];
			default:
				return TOOL_GROUP_LABELS[ToolSource.SERVER];
		}
	}

	private hasServerTool(name: BuiltInTool): boolean {
		return this._serverTools.some((def) => def.function.name === name);
	}

	private inferTypeFromDefault(value: unknown): string | undefined {
		if (typeof value === 'string') return 'string';

		if (typeof value === 'boolean') return 'boolean';

		if (typeof value === 'number') return Number.isInteger(value) ? 'integer' : 'number';

		if (Array.isArray(value)) return 'array';

		if (value !== null && typeof value === 'object') return 'object';

		return undefined;
	}

	private mcpDefinition(
		name: string,
		description: string | undefined,
		schema?: Record<string, unknown>
	): OpenAIToolDefinition {
		return {
			function: {
				description,
				name,
				parameters: schema ?? { properties: {}, required: [], type: JsonSchemaType.OBJECT }
			},
			type: ToolCallType.FUNCTION
		};
	}

	/** Normalize MCP tools from live connections when available, fall back to health check data */
	private mcpEntries(): {
		serverId: string;
		serverName: string;
		definition: OpenAIToolDefinition;
	}[] {
		const out: { serverId: string; serverName: string; definition: OpenAIToolDefinition }[] = [];
		const connections = mcpStore.getConnections();

		if (connections.size > 0) {
			for (const [serverId, connection] of connections) {
				const serverName = mcpStore.getServerDisplayName(serverId);

				for (const tool of connection.tools) {
					const rawSchema = (tool.inputSchema as Record<string, unknown>) ?? {
						properties: {},
						required: [],
						type: JsonSchemaType.OBJECT
					};

					out.push({
						definition: {
							function: {
								description: tool.description,
								name: tool.name,
								parameters: this.normalizeJsonSchema(rawSchema)
							},
							type: ToolCallType.FUNCTION
						},
						serverId,
						serverName
					});
				}
			}
		} else {
			for (const { serverId, serverName, tools } of this.getMcpToolsFromHealthChecks()) {
				for (const tool of tools) {
					out.push({
						definition: this.mcpDefinition(tool.name, tool.description),
						serverId,
						serverName
					});
				}
			}
		}

		return out;
	}

	/**
	 * Recursively normalize a JSON Schema object: infers `type` from `default`
	 * for properties / items that omit it, and descends into nested `properties`
	 * and `items`. Returns a new object -- does not mutate the input.
	 */
	private normalizeJsonSchema(schema: Record<string, unknown>): Record<string, unknown> {
		if (!schema || typeof schema !== 'object') return schema;

		const normalized: Record<string, unknown> = { ...schema };

		if (normalized.properties && typeof normalized.properties === 'object') {
			const props = normalized.properties as Record<string, Record<string, unknown>>;
			const normalizedProps: Record<string, Record<string, unknown>> = {};

			for (const [key, prop] of Object.entries(props)) {
				if (!prop || typeof prop !== 'object') {
					normalizedProps[key] = prop;

					continue;
				}

				const normalizedProp: Record<string, unknown> = { ...prop };

				if (!normalizedProp.type && normalizedProp.default !== undefined) {
					const inferred = this.inferTypeFromDefault(normalizedProp.default);

					if (inferred) normalizedProp.type = inferred;
				}

				if (normalizedProp.properties) {
					Object.assign(
						normalizedProp,
						this.normalizeJsonSchema(normalizedProp as Record<string, unknown>)
					);
				}

				if (normalizedProp.items && typeof normalizedProp.items === 'object') {
					normalizedProp.items = this.normalizeJsonSchema(
						normalizedProp.items as Record<string, unknown>
					);
				}

				normalizedProps[key] = normalizedProp;
			}
			normalized.properties = normalizedProps;
		}

		return normalized;
	}

	private persistDisabledToolCategories(): void {
		try {
			localStorage.setItem(
				DISABLED_TOOL_CATEGORIES_LOCALSTORAGE_KEY,
				JSON.stringify([...this._disabledToolCategories])
			);
		} catch {
			// ignore storage errors
		}
	}

	private persistDisabledTools(): void {
		try {
			localStorage.setItem(
				DISABLED_TOOL_KEYS_LOCALSTORAGE_KEY,
				JSON.stringify([...this._disabledTools])
			);
		} catch {
			// ignore storage errors
		}
	}

	/**
	 * `read_media` runs in the browser on top of the server's `read_file`, so it
	 * exists only when that tool is served and the active model can perceive the
	 * bytes. The server cannot make this call - it does not know which model the
	 * conversation uses.
	 */
	private readMediaTool(): OpenAIToolDefinition | null {
		if (!this.hasServerTool(BuiltInTool.SERVER_READ_FILE)) return null;

		const model = modelsStore.selectedModelName ?? modelsStore.models[0]?.model ?? '';

		if (!model) return null;

		const vision = modelsStore.props.modelSupportsVision(model);
		const audio = modelsStore.props.modelSupportsAudio(model);

		if (!vision && !audio) return null;

		return buildReadMediaToolDefinition(vision, audio);
	}

	private toolKey(source: ToolSource, name: string, serverId?: string): string {
		switch (source) {
			case ToolSource.MCP:
				// with a serverId this is a per-tool key; without one it hits the
				// server group key shape, which no MCP entry ever does
				return serverId ? `mcp-${serverId}:${name}` : this.getMcpServerToolsKey(name);
			case ToolSource.CUSTOM:
				return `custom:${name}`;
			case ToolSource.BROWSER:
				return `browser:${name}`;
			default:
				return `server:${name}`;
		}
	}
}

export const toolsStore = new ToolsStore();