tinyagent-ts/dist/src/decorators.d.ts

Modern TypeScript framework for building AI agents with pluggable tools and ReAct reasoning

import "reflect-metadata";
import { ZodSchema } from "zod";
/**
 * Defines symbols used as keys for storing metadata via `reflect-metadata`.
 */
export declare const META_KEYS: {
    /** Symbol for storing the model name metadata on an agent class. */
    MODEL: symbol;
    /** Symbol for storing the list of tool metadata on an agent class. */
    TOOLS: symbol;
};
/**
 * Class decorator to associate an LLM model name with an agent class.
 * This name is used by the agent to make API calls to the specified model.
 *
 * @param name - The identifier of the LLM model (e.g., "qwen/qwen2-72b-instruct").
 * @returns A class decorator function.
 * @example
 * ```typescript
 * @model("qwen/qwen2-72b-instruct")
 * class MyAgent extends Agent {}
 * ```
 */
export declare function model(name: string): ClassDecorator;
/**
 * Interface defining the structure for metadata associated with a tool.
 * This metadata is used by the agent to understand and execute the tool.
 */
export interface ToolMetadata {
    /** The name of the tool, typically derived from the method name. */
    name: string;
    /** A human-readable description of what the tool does. */
    description: string;
    /** The name of the class method that implements the tool's logic. */
    method: string;
    /** A Zod schema defining the expected parameters for the tool. */
    schema: ZodSchema<any>;
}
/**
 * Property decorator to define a class method as an agent tool.
 * It stores metadata about the tool, including its description and parameter schema.
 *
 * @param description - A human-readable description of the tool's purpose.
 * @param paramSchema - A Zod schema for validating the tool's input parameters. Defaults to an empty object schema.
 * @returns A property decorator function.
 * @example
 * ```typescript
 * class MyAgent extends Agent {
 *   @tool('Adds two numbers', z.object({ a: z.number(), b: z.number() }))
 *   add({ a, b }: { a: number; b: number }): string {
 *     return String(a + b);
 *   }
 * }
 * ```
 */
export declare function tool(description: string, paramSchema?: ZodSchema<any>): PropertyDecorator;