Interface ToolInterface

Base entity interface for all platform resources

All entities in the Mosaia platform extend this interface to provide consistent base properties across all resource types. This ensures that all entities have common fields for identification, status, and integration capabilities.

Example

const entity: BaseEntity = {
  id: 'entity-123',
  active: true,
  external_id: 'external-system-id',
  extensors: {
    custom_field: 'custom_value'
  }
};
interface ToolInterface {
    record_history?: RecordHistory;
    id?: string;
    org?: string;
    user?: string;
    name?: string;
    friendly_name?: string;
    short_description: string;
    tool_schema: string;
    required_environment_variables?: string[];
    source_url?: string;
    url?: string;
    public?: boolean;
    active?: boolean;
    keywords?: string[];
    tags?: string[];
    external_id?: string;
    extensors?: { [key: string]: string };
}

Hierarchy (View Summary)

Properties

record_history? id? org? user? name? friendly_name? short_description tool_schema required_environment_variables? source_url? url? public? active? keywords? tags? external_id? extensors?

Properties

Optionalrecord_history

record_history?: RecordHistory

Record history tracking information

Optionalid

id?: string

Unique identifier for the entity

Optionalorg

org?: string

Optionaluser

user?: string

Optionalname

name?: string

Optionalfriendly_name

friendly_name?: string

short_description

short_description: string

tool_schema

tool_schema: string

Optionalrequired_environment_variables

required_environment_variables?: string[]

Optionalsource_url

source_url?: string

Optionalurl

url?: string

Optionalpublic

public?: boolean

Optionalactive

active?: boolean

Whether the entity is active

Optionalkeywords

keywords?: string[]

Optionaltags

tags?: string[]

Optionalexternal_id

external_id?: string

External system identifier for integration with third-party systems

Optionalextensors

extensors?: { [key: string]: string }

Extended properties for custom integrations

Settings

Member Visibility

On This Page

Properties