lm-studio-toolbox

import { tool, type Tool, type ToolsProvider } from "@lmstudio/sdk";
import type { LMStudioClient } from "@lmstudio/sdk";
import { z } from "zod";
import { appendFile, mkdir } from "fs/promises";
import { join } from "path";
import { homedir } from "os";
import { pluginConfigSchematics } from "./config";
import { getPersistedState, savePersistedState, ensureWorkspaceExists } from "./stateManager";
import type { ToolContext } from "./tools/context";
import { parseProtectedPaths } from "./tools/helpers";

// ── N.11: Audit log ───────────────────────────────────────────────────────────

const AUDIT_LOG_DIR  = join(homedir(), ".lm-studio-toolbox");
const AUDIT_LOG_PATH = join(AUDIT_LOG_DIR, "audit.log");

/** Wrap a tool so every call is logged to audit.log when enableAuditLog is on. */
function withAudit(t: Tool, enabled: boolean): Tool {
  if (!enabled) return t;
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  const wrapped: any = { ...t };
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  wrapped.implementation = async (params: Record<string, unknown>, toolCtx: any): Promise<unknown> => {
      const startMs = Date.now();
      let status = "ok";
      try {
        // eslint-disable-next-line @typescript-eslint/no-explicit-any
        const result = await (t as any).implementation(params, toolCtx);
        if (result && typeof result === "object" && "error" in result) status = "error";
        return result;
      } catch (err) {
        status = "throw";
        throw err;
      } finally {
        const elapsed = Date.now() - startMs;
        // Summarise args: omit large content fields to keep the log readable
        const argsSummary = Object.fromEntries(
          Object.entries(params).map(([k, v]) =>
            [k, typeof v === "string" && v.length > 80 ? `${v.substring(0, 80)}…` : v]
          )
        );
        const entry = JSON.stringify({
          ts: new Date().toISOString(), tool: t.name, args: argsSummary, status, elapsed_ms: elapsed,
        });
        mkdir(AUDIT_LOG_DIR, { recursive: true })
          .then(() => appendFile(AUDIT_LOG_PATH, entry + "\n", "utf-8"))
          .catch(() => {}); // fire-and-forget; never block tool execution
      }
  };
  return wrapped as Tool;
}

import { createFileTools } from "./tools/fileTools";
import { createCodeTools } from "./tools/codeTools";
import { createWebTools } from "./tools/webTools";
import { createBrowserTools } from "./tools/browserTools";
import { createGitTools } from "./tools/gitTools";
import { createGithubTools } from "./tools/githubTools";
import { createMiscTools } from "./tools/miscTools";
import { createMemoryTools } from "./tools/memoryTools";
import { createSubAgentTools } from "./tools/subAgentTools";
import { loadPlugins } from "./pluginLoader";

let isWorkspaceInitialized = false;

export const toolsProvider: ToolsProvider = async (ctl) => {
  const client = (ctl as any).client as LMStudioClient;
  const pluginConfig = ctl.getPluginConfig(pluginConfigSchematics);
  const defaultWorkspacePath = pluginConfig.get("defaultWorkspacePath");

  const fullState = await getPersistedState(defaultWorkspacePath);

  // ── Master permission override ───────────────────────────────────────────────
  const allowAllCode = pluginConfig.get("allowAllCode");
  const ctx: ToolContext = {
    cwd: fullState.currentWorkingDirectory,
    browserSession: null,
    fullState,
    client,
    pluginConfig,
    allowJavascript: allowAllCode || pluginConfig.get("allowJavascriptExecution"),
    allowPython:     allowAllCode || pluginConfig.get("allowPythonExecution"),
    allowTerminal:   allowAllCode || pluginConfig.get("allowTerminalExecution"),
    allowShell:      allowAllCode || pluginConfig.get("allowShellCommandExecution"),
    allowBrowserControl: allowAllCode || pluginConfig.get("allowBrowserControl"),
    enableMemory:    pluginConfig.get("enableMemory"),
    enableWikipedia: pluginConfig.get("enableWikipediaTool"),
    enableLocalRag:  pluginConfig.get("enableLocalRag"),
    enableSecondary: pluginConfig.get("enableSecondaryAgent"),
    allowGit:        pluginConfig.get("allowGitOperations"),
    allowDb:         pluginConfig.get("allowDatabaseInspection"),
    allowNotify:     pluginConfig.get("allowSystemNotifications"),
    allowGitHubTools: pluginConfig.get("allowGitHubTools"),
    embeddingModelName: pluginConfig.get("embeddingModel"),
    protectedPaths: parseProtectedPaths(pluginConfig.get("protectedPaths") ?? ""),
  };

  // ── Workspace initialisation (idempotent) ────────────────────────────────────
  if (!isWorkspaceInitialized) {
    await ensureWorkspaceExists(ctx.cwd);
    fullState.currentWorkingDirectory = ctx.cwd;
    await savePersistedState(fullState);
    console.log(`Working directory set to: ${ctx.cwd}`);
    isWorkspaceInitialized = true;
  }

  // ── Persist UI language override ─────────────────────────────────────────────
  const uiLanguageOverride = pluginConfig.get("uiLanguageOverride");
  if (fullState.uiLanguageOverride !== uiLanguageOverride) {
    fullState.uiLanguageOverride = uiLanguageOverride;
    await savePersistedState(fullState);
    console.log(`[i18n] uiLanguageOverride persisted: "${uiLanguageOverride}". Restart plugin to apply.`);
  }

  // ── Assemble tools from all modules ─────────────────────────────────────────
  // N.12: user plugins appended last so built-ins shadow any name conflicts
  const pluginTools = await loadPlugins();
  const allTools: Tool[] = [
    ...createFileTools(ctx),
    ...createCodeTools(ctx),
    ...createWebTools(ctx),
    ...createBrowserTools(ctx),
    ...createGitTools(ctx),
    ...createGithubTools(ctx),
    ...createMiscTools(ctx),
    ...createMemoryTools(ctx),
    ...createSubAgentTools(ctx),
    ...pluginTools,
  ];

  // ── Phase L: disabledTools filter ───────────────────────────────────────────
  const disabledToolsRaw: string = pluginConfig.get("disabledTools") ?? "";
  const disabledToolNames = new Set(
    disabledToolsRaw.split(",").map((s: string) => s.trim()).filter(Boolean)
  );
  const filteredTools = disabledToolNames.size > 0
    ? allTools.filter(t => !disabledToolNames.has(t.name))
    : allTools;

  // ── N.11: Audit log wrapper ──────────────────────────────────────────────────
  const auditEnabled: boolean = pluginConfig.get("enableAuditLog") ?? false;
  const auditedTools = filteredTools.map(t => withAudit(t, auditEnabled));

  // ── Sort: casual/general-purpose tools first, advanced/developer tools second ─
  const casualTools = new Set([
    "analyze_project",
    "change_directory", "list_directory", "read_file", "read_file_range",
    "save_file", "move_file", "copy_file",
    "delete_path", "delete_files_by_pattern", "make_directory",
    "find_files", "fuzzy_find_local_files", "get_file_metadata",
    "search_in_file", "search_directory", "apply_patch",
    "replace_text_in_file", "multi_replace_text",
    "insert_at_line", "append_file", "delete_lines_in_file",
    "web_search", "fetch_web_content", "wikipedia_search",
    "rag_web_content", "rag_local_files",
    "get_system_info", "read_clipboard", "write_clipboard",
    "open_file", "preview_html", "read_document",
    "save_memory", "list_memories", "search_memories", "update_memory", "delete_memory",
    "save_session_note",
    "save_workspace_profile", "switch_workspace_profile", "list_workspace_profiles",
    "send_notification",
    "git_pull", "git_push", "git_fetch", "git_stash",
  ]);

  auditedTools.sort((a, b) => {
    const aCasual = casualTools.has(a.name);
    const bCasual = casualTools.has(b.name);
    if (aCasual && !bCasual) return -1;
    if (!aCasual && bCasual) return 1;
    return a.name.localeCompare(b.name);
  });

  // ── O2: list_tools meta-tool ──────────────────────────────────────────────────
  // Build a lightweight registry snapshot from the finalized sorted list, then
  // add list_tools itself at the very end so it always appears last alphabetically
  // and is always present regardless of config flags.
  const toolRegistry = auditedTools.map(t => ({
    name: t.name,
    // Take only the first sentence so the list stays concise
    description: ((t.description as string | undefined) ?? "").replace(/\s+/g, " ").split(/[.!?]/)[0].trim().substring(0, 120),
  }));

  auditedTools.push(tool({
    name: "list_tools",
    description: "List all currently enabled tools with their names and one-line descriptions. Use the filter parameter to search by keyword. Useful at the start of a session to discover what's available.",
    parameters: {
      filter: z.string().optional().describe("Case-insensitive keyword to match against tool name or description. Omit to return all tools."),
    },
    implementation: async ({ filter }) => {
      const all = filter
        ? toolRegistry.filter(t => {
            const q = filter.toLowerCase();
            return t.name.includes(q) || t.description.toLowerCase().includes(q);
          })
        : toolRegistry;
      return { total_enabled: toolRegistry.length, matched: all.length, tools: all };
    },
  }));

  return auditedTools;
};