Class SelfEvaluateTool

ITool implementation enabling agents to evaluate their own responses, adjust runtime parameters, and generate performance reports.

Example

const tool = new SelfEvaluateTool({
  config: {
    autoAdjust: false,
    adjustableParams: ['temperature', 'verbosity'],
    maxEvaluationsPerSession: 20,
  },
});

const result = await tool.execute({
  action: 'evaluate',
  response: 'The capital of France is Paris.',
  query: 'What is the capital of France?',
}, context);

Implements

Constructors

constructor

Methods

execute

Properties

id name displayName description category hasSideEffects inputSchema

Constructors

constructor

Methods

execute

Properties

Readonly id

id: "com.framers.emergent.self-evaluate" = 'com.framers.emergent.self-evaluate'

A globally unique identifier for this specific tool (e.g., "web-search-engine-v1.2", "stock-price-fetcher"). This ID is used for internal registration, management, and precise identification. It's recommended to use a namespaced, versioned format (e.g., vendor-toolname-version).

Readonly name

name: "self_evaluate" = 'self_evaluate'

The functional name of the tool, as it should be presented to and used by an LLM in a tool call request (e.g., "searchWeb", "executePythonCode", "getWeatherForecast"). This name must be unique among the set of tools made available to a given GMI/LLM at any time. It should be concise, descriptive, and typically in camelCase or snake_case.

Readonly displayName

displayName: "Self Evaluate" = 'Self Evaluate'

A concise, human-readable title or display name for the tool. Used in user interfaces, logs, or when presenting tool options to developers or users.

Example

"Web Search Engine", "Advanced Python Code Interpreter"

Readonly description

description: string = ...

A detailed, natural language description of what the tool does, its primary purpose, typical use cases, and any important considerations or limitations for its use. This description is critical for an LLM to understand the tool's capabilities and make informed decisions about when and how to invoke it. It should be comprehensive enough for the LLM to grasp the tool's semantics.

Readonly Optional category

category: "emergent" = 'emergent'

Optional. A category or group to which this tool belongs (e.g., "data_analysis", "communication", "file_system", "image_generation"). This is useful for organizing tools, for filtering in UIs or registries, and potentially for aiding an LLM in selecting from a large set of tools.

Readonly Optional hasSideEffects

hasSideEffects: true = true

Optional. Indicates if the tool might have side effects on external systems (e.g., writing to a database, sending an email, making a purchase, modifying a file). Defaults to false if not specified. LLMs or orchestrators might handle tools with side effects with greater caution, potentially requiring explicit user confirmation.

Readonly inputSchema

inputSchema: JSONSchemaObject = ...

The JSON schema defining the structure, types, and constraints of the input arguments object that this tool expects. This schema is used by:

  1. LLMs: To construct valid argument objects when requesting a tool call.
  2. ToolExecutor: For validating the arguments before invoking the tool's execute method. It should follow the JSON Schema specification.

See

https://json-schema.org/

Settings

Member Visibility

Theme

On This Page

constructorexecuteidnamedisplayNamedescriptioncategoryhasSideEffectsinputSchema