@clinebot/core 0.0.6 → 0.0.10

package/src/tools/executors/file-read.ts

@@ -7,6 +7,7 @@
 import * as fs from "node:fs/promises";
 import * as path from "node:path";
 import type { ToolContext } from "@clinebot/agents";
+import type { ReadFileRequest } from "../schemas.js";
 import type { FileReadExecutor } from "../types.js";
 
 /**
@@ -48,7 +49,7 @@ const DEFAULT_FILE_READ_OPTIONS: Required<FileReadExecutorOptions> = {
  *   includeLineNumbers: true,
  * })
  *
- * const content = await readFile("/path/to/file.ts", context)
+ * const content = await readFile({ path: "/path/to/file.ts" }, context)
  * ```
  */
 export function createFileReadExecutor(
@@ -59,7 +60,11 @@ export function createFileReadExecutor(
 		...options,
 	};
 
-	return async (filePath: string, _context: ToolContext): Promise<string> => {
+	return async (
+		request: ReadFileRequest,
+		_context: ToolContext,
+	): Promise<string> => {
+		const { path: filePath, start_line, end_line } = request;
 		const resolvedPath = path.isAbsolute(filePath)
 			? path.normalize(filePath)
 			: path.resolve(process.cwd(), filePath);
@@ -81,19 +86,25 @@ export function createFileReadExecutor(
 
 		// Read file content
 		const content = await fs.readFile(resolvedPath, encoding);
+		const allLines = content.split("\n");
+		const rangeStart = Math.max((start_line ?? 1) - 1, 0);
+		const rangeEndExclusive = Math.min(
+			end_line ?? allLines.length,
+			allLines.length,
+		);
+		const lines = allLines.slice(rangeStart, rangeEndExclusive);
 
 		// Optionally add line numbers - one-based indexing for better readability
 		if (includeLineNumbers) {
-			const lines = content.split("\n");
-			const maxLineNumWidth = String(lines.length).length;
+			const maxLineNumWidth = String(allLines.length).length;
 			return lines
 				.map(
 					(line, i) =>
-						`${String(i + 1).padStart(maxLineNumWidth, " ")} | ${line}`,
+						`${String(rangeStart + i + 1).padStart(maxLineNumWidth, " ")} | ${line}`,
 				)
 				.join("\n");
 		}
 
-		return content;
+		return lines.join("\n");
 	};
 }

package/src/tools/index.ts

@@ -60,6 +60,8 @@ export {
 	EditFileInputSchema,
 	type FetchWebContentInput,
 	FetchWebContentInputSchema,
+	type ReadFileRequest,
+	ReadFileRequestSchema,
 	type ReadFilesInput,
 	ReadFilesInputSchema,
 	type RunCommandsInput,

package/src/tools/presets.ts

@@ -147,7 +147,7 @@ export function createToolPoliciesWithPreset(
  * ```typescript
  * const tools = createDefaultToolsWithPreset("readonly", {
  *   executors: {
- *     readFile: async (path) => fs.readFile(path, "utf-8"),
+ *     readFile: async ({ path }) => fs.readFile(path, "utf-8"),
  *     search: async (query, cwd) => searchFiles(query, cwd),
  *     webFetch: async (url, prompt) => fetchAndAnalyze(url, prompt),
  *   },

package/src/tools/schemas.ts

@@ -14,14 +14,57 @@ const AbsolutePath = z
 	.string()
 	.describe("The absolute file path of a text file to read content from");
 
+export const ReadFileLineRangeSchema = z
+	.object({
+		start_line: z
+			.number()
+			.int()
+			.positive()
+			.optional()
+			.describe("Optional one-based starting line number to read from"),
+		end_line: z
+			.number()
+			.int()
+			.positive()
+			.optional()
+			.describe("Optional one-based ending line number to read through"),
+	})
+	.refine(
+		({ start_line, end_line }) =>
+			start_line === undefined ||
+			end_line === undefined ||
+			start_line <= end_line,
+		{
+			message: "start_line must be less than or equal to end_line",
+			path: ["end_line"],
+		},
+	);
+
+export const ReadFileRequestSchema = z
+	.object({
+		path: AbsolutePath,
+		start_line: ReadFileLineRangeSchema.shape.start_line,
+		end_line: ReadFileLineRangeSchema.shape.end_line,
+	})
+	.refine(
+		({ start_line, end_line }) =>
+			start_line === undefined ||
+			end_line === undefined ||
+			start_line <= end_line,
+		{
+			message: "start_line must be less than or equal to end_line",
+			path: ["end_line"],
+		},
+	);
+
 /**
  * Schema for read_files tool input
  */
 export const ReadFilesInputSchema = z.object({
-	file_paths: z
-		.array(AbsolutePath)
+	files: z
+		.array(ReadFileRequestSchema)
 		.describe(
-			"Array of absolute file paths to get full content from. Prefer this tool over running terminal command to get file content for better performance and reliability.",
+			"Array of file read requests. Omit start_line and end_line to return the full file content; provide them to return only that inclusive one-based line range. Prefer this tool over running terminal command to get file content for better performance and reliability.",
 		),
 });
 
@@ -30,8 +73,13 @@ export const ReadFilesInputSchema = z.object({
  */
 export const ReadFilesInputUnionSchema = z.union([
 	ReadFilesInputSchema,
+	ReadFileRequestSchema,
+	z.array(ReadFileRequestSchema),
 	z.array(z.string()),
 	z.string(),
+	z.object({ files: ReadFileRequestSchema }),
+	z.object({ file_paths: z.array(AbsolutePath) }),
+	z.object({ file_paths: z.string() }),
 ]);
 
 /**
@@ -50,16 +98,22 @@ export const SearchCodebaseUnionInputSchema = z.union([
 	SearchCodebaseInputSchema,
 	z.array(z.string()),
 	z.string(),
+	z.object({ queries: z.string() }),
 ]);
 
-const CommandInputSchema = z.string();
+const CommandInputSchema = z
+	.string()
+	.max(2000)
+	.describe(
+		"The non-interactive shell command to execute - MUST keep input short and concise to avoid timeouts",
+	);
 /**
  * Schema for run_commands tool input
  */
 export const RunCommandsInputSchema = z.object({
 	commands: z
 		.array(CommandInputSchema)
-		.describe("Array of shell commands to execute."),
+		.describe("Array of shell commands to execute"),
 });
 
 /**
@@ -67,8 +121,9 @@ export const RunCommandsInputSchema = z.object({
  */
 export const RunCommandsInputUnionSchema = z.union([
 	RunCommandsInputSchema,
-	z.array(CommandInputSchema),
-	CommandInputSchema,
+	z.object({ commands: CommandInputSchema }),
+	z.array(z.string()),
+	z.string(),
 ]);
 
 /**
@@ -93,46 +148,36 @@ export const FetchWebContentInputSchema = z.object({
  */
 export const EditFileInputSchema = z
 	.object({
-		command: z
-			.enum(["create", "str_replace", "insert"])
-			.describe("Editor command to execute: create, str_replace, insert"),
-		path: z.string().min(1).describe("Absolute file path"),
-		file_text: z
+		path: z
 			.string()
-			.nullish()
-			.describe("Full file content required for 'create' command"),
-		old_str: z
+			.min(1)
+			.describe("The absolute file path for the action to be performed on"),
+		old_text: z
 			.string()
-			.nullish()
+			.max(3000)
+			.nullable()
+			.optional()
 			.describe(
-				"Exact text to replace (must match exactly once) for 'str_replace' command",
+				"Exact text to replace (must match exactly once). Omit this when creating a missing file or inserting via insert_line.",
 			),
-		new_str: z
+		new_text: z
 			.string()
-			.nullish()
-			.describe("Replacement text for 'str_replace' or 'insert' commands"),
+			.max(3000)
+			.describe(
+				"The new content to write when creating a missing file, the replacement text for edits, or the inserted text when insert_line is provided - IMPORTANT: keep this as small as possible to avoid timeouts. For large edits, use multiple calls with small chunks of new_text and precise old_text to iteratively edit the file.",
+			),
 		insert_line: z
 			.number()
 			.int()
-			.nullish()
-			.describe("Optional one-based line index for 'insert' command"),
-	})
-	.refine((v) => v.command !== "create" || v.file_text != null, {
-		path: ["file_text"],
-		message: "file_text is required for command=create",
-	})
-	.refine((v) => v.command !== "str_replace" || v.old_str != null, {
-		path: ["old_str"],
-		message: "old_str is required for command=str_replace",
-	})
-	.refine((v) => v.command !== "insert" || v.insert_line != null, {
-		path: ["insert_line"],
-		message: "insert_line is required for command=insert",
+			.nullable()
+			.optional()
+			.describe(
+				"Optional one-based line index. When provided, the tool inserts new_text at that line instead of performing a replacement edit.",
+			),
 	})
-	.refine((v) => v.command !== "insert" || v.new_str != null, {
-		path: ["new_str"],
-		message: "new_str is required for command=insert",
-	});
+	.describe(
+		"Edit a text file by replacing old_text with new_text, create the file with new_text if it does not exist, or insert new_text at insert_line when insert_line is provided. IMPORTANT: large edits can time out, so use small chunks and multiple calls when possible.",
+	);
 
 /**
  * Schema for apply_patch tool input
@@ -188,6 +233,11 @@ export const AskQuestionInputSchema = z.object({
 // Type Definitions (derived from Zod schemas)
 // =============================================================================
 
+/**
+ * Input for a single file read request
+ */
+export type ReadFileRequest = z.infer<typeof ReadFileRequestSchema>;
+
 /**
  * Input for the read_files tool
  */

package/src/tools/types.ts

@@ -5,7 +5,11 @@
  */
 
 import type { ToolContext } from "@clinebot/agents";
-import type { ApplyPatchInput, EditFileInput } from "./schemas";
+import type {
+	ApplyPatchInput,
+	EditFileInput,
+	ReadFileRequest,
+} from "./schemas";
 
 // =============================================================================
 // Tool Result Types
@@ -34,12 +38,12 @@ export interface ToolOperationResult {
 /**
  * Executor for reading files
  *
- * @param filePath - Absolute path to the file to read
+ * @param request - File path and optional inclusive line range to read
  * @param context - Tool execution context
  * @returns The file content as a string
  */
 export type FileReadExecutor = (
-	filePath: string,
+	request: ReadFileRequest,
 	context: ToolContext,
 ) => Promise<string>;
 

package/src/types/config.ts

@@ -7,7 +7,7 @@ import type {
 	TeamEvent,
 	Tool,
 } from "@clinebot/agents";
-import type { providers as LlmsProviders } from "@clinebot/llms";
+import type { LlmsProviders } from "@clinebot/llms";
 import type {
 	AgentMode,
 	BasicLogger,

package/src/types/events.ts

@@ -13,7 +13,12 @@ export interface SessionEndedEvent {
 
 export interface SessionToolEvent {
 	sessionId: string;
-	hookEventName: "tool_call" | "tool_result" | "agent_end" | "session_shutdown";
+	hookEventName:
+		| "tool_call"
+		| "tool_result"
+		| "agent_end"
+		| "agent_error"
+		| "session_shutdown";
 	agentId?: string;
 	conversationId?: string;
 	parentAgentId?: string;

package/src/types/provider-settings.ts

@@ -1,11 +1,11 @@
-import { providers } from "@clinebot/llms";
+import { LlmsProviders } from "@clinebot/llms";
 import { z } from "zod";
 
-export type ProviderConfig = providers.ProviderConfig;
-export type ProviderSettings = providers.ProviderSettings;
+export type ProviderConfig = LlmsProviders.ProviderConfig;
+export type ProviderSettings = LlmsProviders.ProviderSettings;
 export const ProviderSettingsSchema: z.ZodType<ProviderSettings> =
-	providers.ProviderSettingsSchema;
-export const toProviderConfig = providers.toProviderConfig;
+	LlmsProviders.ProviderSettingsSchema;
+export const toProviderConfig = LlmsProviders.toProviderConfig;
 
 export type ProviderTokenSource = "manual" | "oauth" | "migration";
 
@@ -23,7 +23,7 @@ export interface StoredProviderSettings {
 
 export const StoredProviderSettingsEntrySchema: z.ZodType<StoredProviderSettingsEntry> =
 	z.object({
-		settings: providers.ProviderSettingsSchema,
+		settings: LlmsProviders.ProviderSettingsSchema,
 		updatedAt: z.string().datetime(),
 		tokenSource: z.enum(["manual", "oauth", "migration"]).default("manual"),
 	});

package/src/types.ts

@@ -1,4 +1,4 @@
-import type { providers as LlmsProviders } from "@clinebot/llms";
+import type { LlmsProviders } from "@clinebot/llms";
 import type { CoreSessionEvent } from "./types/events";
 
 export type {