Skip to main content

OpenMolt

openmolt

openmolt / OpenMolt

Class: OpenMolt

Defined in: OpenMolt.ts:92

The main OpenMolt class.

Manages LLM provider configuration, integration registration, and agent creation.

Constructors​

Constructor​

new OpenMolt(config?): OpenMolt

Defined in: OpenMolt.ts:102

Create a new OpenMolt instance.

Parameters​

config?​

OpenMoltConfig = {}

Global configuration including LLM provider API keys, integration configs, max steps, and verbosity.

Returns​

OpenMolt

Methods​

createAgent()​

createAgent(config): Agent

Defined in: OpenMolt.ts:138

Create a new Agent instance.

Parameters​

config​

AgentConfig

Agent configuration.

Returns​

Agent

A fully configured, ready-to-run agent.

getIntegration()​

getIntegration(handle): Integration | undefined

Defined in: OpenMolt.ts:147

Retrieve a registered integration by handle.

Parameters​

handle​

string

Integration handle.

Returns​

Integration | undefined

listIntegrations()​

listIntegrations(): string[]

Defined in: OpenMolt.ts:154

Returns an array of all registered integration handles.

Returns​

string[]

registerIntegration()​

registerIntegration(handle, definition): this

Defined in: OpenMolt.ts:127

Register a custom integration (or override an existing one).

The integration will be available to any agent created after this call that includes the handle in its integrations list.

Parameters​

handle​

string

Unique identifier for the integration.

definition​

IntegrationDefinition

Integration definition (tools, API setup, scopes, etc.).

Returns​

this

Example​

om.registerIntegration('myApi', {
  name: 'My API',
  apiSetup: { baseUrl: 'https://api.example.com' },
  tools: [ ... ],
});

FileSystemIntegration()​

static FileSystemIntegration(directories): IntegrationDefinition

Defined in: OpenMolt.ts:171

Create a FileSystem integration definition restricted to the given directories.

Register the result via registerIntegration:

om.registerIntegration('fileSystem', OpenMolt.FileSystemIntegration('/data'));

Parameters​

directories​

Allowed base directory or array of directories.

string | string[]

Returns​

IntegrationDefinition