@theokit/sdk-tools 0.11.0 → 0.12.0

package/dist/index.d.cts

@@ -339,6 +339,17 @@ declare function catastrophicShellReason(command: string): string | null;
  * name/inputSchema/handler; does NOT mutate the original tool.
  */
 declare function withDescription(tool: CustomTool, description: string): CustomTool;
+/**
+ * Return a new `CustomTool` exposed under a different `name`, sharing the SAME
+ * `inputSchema` + `handler` (alias parity). Preserves description; does NOT mutate
+ * the original. This is how an agent exposes a built-in under its preferred name —
+ * e.g. a Codex-style agent aliases `search_text` → `grep`, `shell_exec` → `run_shell`
+ * — without re-implementing the tool. Pure, never throws: the final `name` is
+ * validated by the SDK at tool-registration time (the single authority for the
+ * `^[a-zA-Z][a-zA-Z0-9_-]{0,63}$` + reserved-name rules), so this helper does not
+ * re-validate (no duplicated contract).
+ */
+declare function withName(tool: CustomTool, name: string): CustomTool;
 /** Render mode for {@link renderToolList}. Local — the published `renderToolList`
  *  signature inlines this union into its `.d.ts`, so consumers pass the literal
  *  ("summary" | "names" | "full") without needing the named type exported. */
@@ -580,7 +591,7 @@ declare function createReadFileTool(opts: CreateReadFileToolOptions): CustomTool
  * SE37 — the public reasoning toolkit: `ReasoningTools.create()` returns a
  * `think` + `analyze` scratchpad (no-side-effect tools that echo the model's
  * structured reasoning back as an observation, so the ReAct loop feeds it
- * forward). Mirrors Anthropic's "think" tool + Agno's `ReasoningTools`.
+ * forward). Mirrors Anthropic's "think" tool + a peer's `ReasoningTools`.
  *
  * Lives in `@theokit/sdk-tools` (not core) so the full toolkit stays out of the
  * core bundle. The `reasoning: true` agent flag auto-attaches an equivalent
@@ -700,7 +711,7 @@ declare function createShellTool(opts: CreateShellToolOptions): CustomTool;
  * `todolist` — in-session task tracking for multi-step work.
  *
  * The agent uses this to plan complex tasks and track progress.
- * Inspired by OpenCode's todo.ts and Claude Code's TodoWrite.
+ * Inspired by a peer project's todo.ts and Claude Code's TodoWrite.
  *
  * Actions:
  *   - add(title)         → add a new todo item
@@ -964,4 +975,4 @@ interface CreateWriteFileToolOptions {
 }
 declare function createWriteFileTool(opts: CreateWriteFileToolOptions): CustomTool;
 
-export { CatastrophicCommandError, type CommandPolicy, type CreateApplyPatchToolOptions, type CreateBraveWebSearchAdapterOptions, type CreateEditFileToolOptions, type CreateGenericHttpSearchAdapterOptions, type CreateGitDiffToolOptions, type CreateGlobToolOptions, type CreateListDirToolOptions, type CreateReadFileToolOptions, type CreateRunVitestToolOptions, type CreateSearchTextToolOptions, type CreateShellToolOptions, type CreateWebFetchToolOptions, type CreateWebSearchToolOptions, type CreateWriteFileToolOptions, DEFAULT_TOOL_GUIDANCE, type EnvContextOptions, type PlanModeTool, type PlanModeToolOptions, type PlanModeToolWithStore, type PlanNode, type QuestionTool, type QuestionToolOptions, ReadTracker, ReasoningTools, RedirectBlockedError, type RepoMapOptions, type ResolveAndScreenOptions, type ScreenedFetchOptions, type SessionArtifactStore, type SessionArtifactStoreOptions, SsrfBlockedError, type TodoItem, type TodolistTool, type ToolGuidanceMap, type TruncationOptions, type TruncationResult, type VitestSummary, type WebSearchCallback, type WebSearchResult, buildEnvContext, buildRepoMap, catastrophicShellReason, commandDenialReason, createApplyPatchTool, createBraveWebSearchAdapter, createEditFileTool, createGenericHttpSearchAdapter, createGitDiffTool, createGlobTool, createListDirTool, createPlanModeTool, createQuestionTool, createReadFileTool, createRunVitestTool, createSearchTextTool, createSessionArtifactStore, createShellTool, createTodolistTool, createWebFetchTool, createWebSearchTool, createWriteFileTool, denyCatastrophicCommands, formatCode, formatDiff, formatError, formatFileList, injectGuidance, isBlockedIp, isCommandAllowed, renderToolList, resolveAndScreen, screenedFetch, todoItemsToPlanNodes, truncateOutput, withDefaultGuidance, withDescription, withShellExitGuidance, withToolResultGuidance };
+export { CatastrophicCommandError, type CommandPolicy, type CreateApplyPatchToolOptions, type CreateBraveWebSearchAdapterOptions, type CreateEditFileToolOptions, type CreateGenericHttpSearchAdapterOptions, type CreateGitDiffToolOptions, type CreateGlobToolOptions, type CreateListDirToolOptions, type CreateReadFileToolOptions, type CreateRunVitestToolOptions, type CreateSearchTextToolOptions, type CreateShellToolOptions, type CreateWebFetchToolOptions, type CreateWebSearchToolOptions, type CreateWriteFileToolOptions, DEFAULT_TOOL_GUIDANCE, type EnvContextOptions, type PlanModeTool, type PlanModeToolOptions, type PlanModeToolWithStore, type PlanNode, type QuestionTool, type QuestionToolOptions, ReadTracker, ReasoningTools, RedirectBlockedError, type RepoMapOptions, type ResolveAndScreenOptions, type ScreenedFetchOptions, type SessionArtifactStore, type SessionArtifactStoreOptions, SsrfBlockedError, type TodoItem, type TodolistTool, type ToolGuidanceMap, type TruncationOptions, type TruncationResult, type VitestSummary, type WebSearchCallback, type WebSearchResult, buildEnvContext, buildRepoMap, catastrophicShellReason, commandDenialReason, createApplyPatchTool, createBraveWebSearchAdapter, createEditFileTool, createGenericHttpSearchAdapter, createGitDiffTool, createGlobTool, createListDirTool, createPlanModeTool, createQuestionTool, createReadFileTool, createRunVitestTool, createSearchTextTool, createSessionArtifactStore, createShellTool, createTodolistTool, createWebFetchTool, createWebSearchTool, createWriteFileTool, denyCatastrophicCommands, formatCode, formatDiff, formatError, formatFileList, injectGuidance, isBlockedIp, isCommandAllowed, renderToolList, resolveAndScreen, screenedFetch, todoItemsToPlanNodes, truncateOutput, withDefaultGuidance, withDescription, withName, withShellExitGuidance, withToolResultGuidance };

package/dist/index.d.ts

@@ -339,6 +339,17 @@ declare function catastrophicShellReason(command: string): string | null;
  * name/inputSchema/handler; does NOT mutate the original tool.
  */
 declare function withDescription(tool: CustomTool, description: string): CustomTool;
+/**
+ * Return a new `CustomTool` exposed under a different `name`, sharing the SAME
+ * `inputSchema` + `handler` (alias parity). Preserves description; does NOT mutate
+ * the original. This is how an agent exposes a built-in under its preferred name —
+ * e.g. a Codex-style agent aliases `search_text` → `grep`, `shell_exec` → `run_shell`
+ * — without re-implementing the tool. Pure, never throws: the final `name` is
+ * validated by the SDK at tool-registration time (the single authority for the
+ * `^[a-zA-Z][a-zA-Z0-9_-]{0,63}$` + reserved-name rules), so this helper does not
+ * re-validate (no duplicated contract).
+ */
+declare function withName(tool: CustomTool, name: string): CustomTool;
 /** Render mode for {@link renderToolList}. Local — the published `renderToolList`
  *  signature inlines this union into its `.d.ts`, so consumers pass the literal
  *  ("summary" | "names" | "full") without needing the named type exported. */
@@ -580,7 +591,7 @@ declare function createReadFileTool(opts: CreateReadFileToolOptions): CustomTool
  * SE37 — the public reasoning toolkit: `ReasoningTools.create()` returns a
  * `think` + `analyze` scratchpad (no-side-effect tools that echo the model's
  * structured reasoning back as an observation, so the ReAct loop feeds it
- * forward). Mirrors Anthropic's "think" tool + Agno's `ReasoningTools`.
+ * forward). Mirrors Anthropic's "think" tool + a peer's `ReasoningTools`.
  *
  * Lives in `@theokit/sdk-tools` (not core) so the full toolkit stays out of the
  * core bundle. The `reasoning: true` agent flag auto-attaches an equivalent
@@ -700,7 +711,7 @@ declare function createShellTool(opts: CreateShellToolOptions): CustomTool;
  * `todolist` — in-session task tracking for multi-step work.
  *
  * The agent uses this to plan complex tasks and track progress.
- * Inspired by OpenCode's todo.ts and Claude Code's TodoWrite.
+ * Inspired by a peer project's todo.ts and Claude Code's TodoWrite.
  *
  * Actions:
  *   - add(title)         → add a new todo item
@@ -964,4 +975,4 @@ interface CreateWriteFileToolOptions {
 }
 declare function createWriteFileTool(opts: CreateWriteFileToolOptions): CustomTool;
 
-export { CatastrophicCommandError, type CommandPolicy, type CreateApplyPatchToolOptions, type CreateBraveWebSearchAdapterOptions, type CreateEditFileToolOptions, type CreateGenericHttpSearchAdapterOptions, type CreateGitDiffToolOptions, type CreateGlobToolOptions, type CreateListDirToolOptions, type CreateReadFileToolOptions, type CreateRunVitestToolOptions, type CreateSearchTextToolOptions, type CreateShellToolOptions, type CreateWebFetchToolOptions, type CreateWebSearchToolOptions, type CreateWriteFileToolOptions, DEFAULT_TOOL_GUIDANCE, type EnvContextOptions, type PlanModeTool, type PlanModeToolOptions, type PlanModeToolWithStore, type PlanNode, type QuestionTool, type QuestionToolOptions, ReadTracker, ReasoningTools, RedirectBlockedError, type RepoMapOptions, type ResolveAndScreenOptions, type ScreenedFetchOptions, type SessionArtifactStore, type SessionArtifactStoreOptions, SsrfBlockedError, type TodoItem, type TodolistTool, type ToolGuidanceMap, type TruncationOptions, type TruncationResult, type VitestSummary, type WebSearchCallback, type WebSearchResult, buildEnvContext, buildRepoMap, catastrophicShellReason, commandDenialReason, createApplyPatchTool, createBraveWebSearchAdapter, createEditFileTool, createGenericHttpSearchAdapter, createGitDiffTool, createGlobTool, createListDirTool, createPlanModeTool, createQuestionTool, createReadFileTool, createRunVitestTool, createSearchTextTool, createSessionArtifactStore, createShellTool, createTodolistTool, createWebFetchTool, createWebSearchTool, createWriteFileTool, denyCatastrophicCommands, formatCode, formatDiff, formatError, formatFileList, injectGuidance, isBlockedIp, isCommandAllowed, renderToolList, resolveAndScreen, screenedFetch, todoItemsToPlanNodes, truncateOutput, withDefaultGuidance, withDescription, withShellExitGuidance, withToolResultGuidance };
+export { CatastrophicCommandError, type CommandPolicy, type CreateApplyPatchToolOptions, type CreateBraveWebSearchAdapterOptions, type CreateEditFileToolOptions, type CreateGenericHttpSearchAdapterOptions, type CreateGitDiffToolOptions, type CreateGlobToolOptions, type CreateListDirToolOptions, type CreateReadFileToolOptions, type CreateRunVitestToolOptions, type CreateSearchTextToolOptions, type CreateShellToolOptions, type CreateWebFetchToolOptions, type CreateWebSearchToolOptions, type CreateWriteFileToolOptions, DEFAULT_TOOL_GUIDANCE, type EnvContextOptions, type PlanModeTool, type PlanModeToolOptions, type PlanModeToolWithStore, type PlanNode, type QuestionTool, type QuestionToolOptions, ReadTracker, ReasoningTools, RedirectBlockedError, type RepoMapOptions, type ResolveAndScreenOptions, type ScreenedFetchOptions, type SessionArtifactStore, type SessionArtifactStoreOptions, SsrfBlockedError, type TodoItem, type TodolistTool, type ToolGuidanceMap, type TruncationOptions, type TruncationResult, type VitestSummary, type WebSearchCallback, type WebSearchResult, buildEnvContext, buildRepoMap, catastrophicShellReason, commandDenialReason, createApplyPatchTool, createBraveWebSearchAdapter, createEditFileTool, createGenericHttpSearchAdapter, createGitDiffTool, createGlobTool, createListDirTool, createPlanModeTool, createQuestionTool, createReadFileTool, createRunVitestTool, createSearchTextTool, createSessionArtifactStore, createShellTool, createTodolistTool, createWebFetchTool, createWebSearchTool, createWriteFileTool, denyCatastrophicCommands, formatCode, formatDiff, formatError, formatFileList, injectGuidance, isBlockedIp, isCommandAllowed, renderToolList, resolveAndScreen, screenedFetch, todoItemsToPlanNodes, truncateOutput, withDefaultGuidance, withDescription, withName, withShellExitGuidance, withToolResultGuidance };

package/dist/index.js

@@ -3,8 +3,8 @@ import { dirname, join, relative, resolve, sep } from 'path';
 import { Tool, ConfigurationError } from '@theokit/sdk';
 import { z } from 'zod';
 import { existsSync, statSync, mkdirSync, writeFileSync, realpathSync, readFileSync, lstatSync, readlinkSync, readdirSync } from 'fs';
-import { replaceFileAtomic } from '@theokit/sdk/internal/persistence';
 import { safeFilenameForId, safePathJoin as safePathJoin$1 } from '@theokit/sdk/path-safety';
+import { replaceFileAtomic } from '@theokit/sdk/persistence';
 import { spawn } from 'child_process';
 import { lookup } from 'dns/promises';
 import { isIP } from 'net';
@@ -988,6 +988,14 @@ function withDescription(tool, description) {
     handler: tool.handler
   };
 }
+function withName(tool, name) {
+  return {
+    name,
+    description: tool.description,
+    inputSchema: tool.inputSchema,
+    handler: tool.handler
+  };
+}
 function esc(s) {
   return String(s).replaceAll("&", "&amp;").replaceAll("<", "&lt;").replaceAll(">", "&gt;");
 }
@@ -2239,6 +2247,6 @@ async function isBinaryFile(absolutePath) {
   }
 }
 
-export { CatastrophicCommandError, DEFAULT_TOOL_GUIDANCE, ReadTracker, ReasoningTools, RedirectBlockedError, SsrfBlockedError, buildEnvContext, buildRepoMap, catastrophicShellReason, commandDenialReason, createApplyPatchTool, createBraveWebSearchAdapter, createEditFileTool, createGenericHttpSearchAdapter, createGitDiffTool, createGlobTool, createListDirTool, createPlanModeTool, createQuestionTool, createReadFileTool, createRunVitestTool, createSearchTextTool, createSessionArtifactStore, createShellTool, createTodolistTool, createWebFetchTool, createWebSearchTool, createWriteFileTool, denyCatastrophicCommands, formatCode, formatDiff, formatError, formatFileList, injectGuidance, isBlockedIp, isCommandAllowed, renderToolList, resolveAndScreen, screenedFetch, todoItemsToPlanNodes, truncateOutput, withDefaultGuidance, withDescription, withShellExitGuidance, withToolResultGuidance };
+export { CatastrophicCommandError, DEFAULT_TOOL_GUIDANCE, ReadTracker, ReasoningTools, RedirectBlockedError, SsrfBlockedError, buildEnvContext, buildRepoMap, catastrophicShellReason, commandDenialReason, createApplyPatchTool, createBraveWebSearchAdapter, createEditFileTool, createGenericHttpSearchAdapter, createGitDiffTool, createGlobTool, createListDirTool, createPlanModeTool, createQuestionTool, createReadFileTool, createRunVitestTool, createSearchTextTool, createSessionArtifactStore, createShellTool, createTodolistTool, createWebFetchTool, createWebSearchTool, createWriteFileTool, denyCatastrophicCommands, formatCode, formatDiff, formatError, formatFileList, injectGuidance, isBlockedIp, isCommandAllowed, renderToolList, resolveAndScreen, screenedFetch, todoItemsToPlanNodes, truncateOutput, withDefaultGuidance, withDescription, withName, withShellExitGuidance, withToolResultGuidance };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map