@agentier/tools 0.1.0

package/dist/fetch.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Configuration options for the {@link fetchTool} factory.
+ */
+export interface FetchToolOptions {
+    /**
+     * Regex patterns specifying which URLs the tool is allowed to request.
+     * When provided, only matching URLs are accessible.
+     */
+    allowedUrls?: RegExp[];
+    /**
+     * Regex patterns specifying which URLs the tool must not request.
+     * Deny rules are evaluated before allow rules.
+     */
+    deniedUrls?: RegExp[];
+    /**
+     * Maximum time in milliseconds to wait for a response before aborting.
+     * @defaultValue `30_000` (30 seconds)
+     */
+    timeout?: number;
+    /**
+     * Maximum response body size in bytes. Responses exceeding this limit are
+     * truncated and flagged with `truncated: true`.
+     * @defaultValue `5_242_880` (5 MB)
+     */
+    maxResponseSize?: number;
+}
+/**
+ * Creates a tool definition that performs HTTP requests using the global
+ * `fetch` API.
+ *
+ * The tool validates URLs against optional allow/deny regex lists, enforces
+ * a request timeout, and truncates oversized response bodies. The parent
+ * context's abort signal is forwarded so cancellation propagates correctly.
+ *
+ * @param options - Optional configuration for URL security, timeouts, and
+ *                  response size limits.
+ * @returns A tool definition compatible with the agentier core runtime.
+ *
+ * @example
+ * ```ts
+ * import { fetchTool } from '@agentier/tools'
+ *
+ * const tool = fetchTool({
+ *   allowedUrls: [/^https:\/\/api\.example\.com/],
+ *   timeout: 10_000,
+ * })
+ * ```
+ */
+export declare function fetchTool(options?: FetchToolOptions): import("@agentier/core").Tool<{
+    url: string;
+    method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | undefined;
+    headers?: Record<string, string> | undefined;
+    body?: string | undefined;
+}, {
+    status: number;
+    headers: {
+        [k: string]: string;
+    };
+    body: string;
+    truncated: boolean;
+} | {
+    status: number;
+    headers: {
+        [k: string]: string;
+    };
+    body: string;
+    truncated?: undefined;
+}>;

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @module @agentier/tools
+ *
+ * A collection of pre-built tool definitions for the agentier runtime.
+ * Each factory function returns a tool that can be registered with an agent:
+ *
+ * - {@link readFileTool} -- Read files from the filesystem.
+ * - {@link writeFileTool} -- Write or create files on the filesystem.
+ * - {@link fetchTool} -- Make HTTP requests.
+ * - {@link shellTool} -- Execute shell commands.
+ *
+ * All tools enforce configurable security boundaries (path globs, URL
+ * regexes, command regexes) to limit what the agent is allowed to do.
+ */
+export { readFileTool } from './read-file';
+export type { ReadFileToolOptions } from './read-file';
+export { writeFileTool } from './write-file';
+export type { WriteFileToolOptions } from './write-file';
+export { fetchTool } from './fetch';
+export type { FetchToolOptions } from './fetch';
+export { shellTool } from './shell';
+export type { ShellToolOptions } from './shell';