@clinebot/core 0.0.7 → 0.0.11

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

@@ -12,14 +12,38 @@ describe("createFileReadExecutor", () => {
 
 		try {
 			const readFile = createFileReadExecutor();
-			const result = await readFile(filePath, {
-				agentId: "agent-1",
-				conversationId: "conv-1",
-				iteration: 1,
-			});
+			const result = await readFile(
+				{ path: filePath },
+				{
+					agentId: "agent-1",
+					conversationId: "conv-1",
+					iteration: 1,
+				},
+			);
 			expect(result).toBe("1 | hello absolute path");
 		} finally {
 			await fs.rm(dir, { recursive: true, force: true });
 		}
 	});
+
+	it("returns only the requested inclusive line range", async () => {
+		const dir = await fs.mkdtemp(path.join(os.tmpdir(), "agents-file-read-"));
+		const filePath = path.join(dir, "example.txt");
+		await fs.writeFile(filePath, "alpha\nbeta\ngamma\ndelta", "utf-8");
+
+		try {
+			const readFile = createFileReadExecutor();
+			const result = await readFile(
+				{ path: filePath, start_line: 2, end_line: 3 },
+				{
+					agentId: "agent-1",
+					conversationId: "conv-1",
+					iteration: 1,
+				},
+			);
+			expect(result).toBe("2 | beta\n3 | gamma");
+		} finally {
+			await fs.rm(dir, { recursive: true, force: true });
+		}
+	});
 });

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,11 +98,15 @@ export const SearchCodebaseUnionInputSchema = z.union([
 	SearchCodebaseInputSchema,
 	z.array(z.string()),
 	z.string(),
+	z.object({ queries: z.string() }),
 ]);
 
 const CommandInputSchema = z
 	.string()
-	.describe("The non-interactive shell command to execute");
+	.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
  */
@@ -69,6 +121,7 @@ export const RunCommandsInputSchema = z.object({
  */
 export const RunCommandsInputUnionSchema = z.union([
 	RunCommandsInputSchema,
+	z.object({ commands: CommandInputSchema }),
 	z.array(z.string()),
 	z.string(),
 ]);
@@ -101,6 +154,7 @@ export const EditFileInputSchema = z
 			.describe("The absolute file path for the action to be performed on"),
 		old_text: z
 			.string()
+			.max(3000)
 			.nullable()
 			.optional()
 			.describe(
@@ -108,8 +162,9 @@ export const EditFileInputSchema = z
 			),
 		new_text: z
 			.string()
+			.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",
+				"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()
@@ -178,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/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 {