Interface ToolInterface

Tool entity interface

Mirrors macs-node-sdk/lib/tools/models/tool.js. Tools are callable units (HTTP endpoints) that agents invoke during chat. Required fields on create: name, friendly_name, short_description, tool_schema, url.

interface ToolInterface {
    external_id?: string;
    extensors?: { [key: string]: string };
    record_history?: RecordHistory;
    id?: string;
    org?: string;
    user?: string;
    image?: string;
    name: string;
    friendly_name: string;
    friendly_name_slug?: string;
    short_description: string;
    source_url?: string;
    tool_schema: object;
    default_environment_secrets?: string;
    required_environment_variables?: string[];
    url: string;
    public?: boolean;
    featured?: boolean;
    active?: boolean;
    keywords?: string[];
    tags?: string[];
}

Hierarchy (View Summary)

Properties

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

Properties

Optionalexternal_id

external_id?: string

External system identifier for integration with third-party systems

Optionalextensors

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

Extended properties for custom integrations

Optionalrecord_history

record_history?: RecordHistory

Record history tracking information

Optionalid

id?: string

Unique identifier for the entity

Optionalorg

org?: string

Optionaluser

user?: string

Optionalimage

image?: string

name

name: string

Machine name (required, unique)

friendly_name

friendly_name: string

Human-readable name (required)

Optional Readonlyfriendly_name_slug

friendly_name_slug?: string

URL-safe slug derived from friendly_name — auto-generated server-side

short_description

short_description: string

One-line description (required)

Optionalsource_url

source_url?: string

Link to the tool's source repo (optional)

tool_schema

tool_schema: object

JSON-Schema object describing the tool's arguments (required)

Optionaldefault_environment_secrets

default_environment_secrets?: string

Default per-tool secrets (encrypted server-side)

Optionalrequired_environment_variables

required_environment_variables?: string[]

Environment variable names the tool requires at execution time

url

url: string

Tool execution endpoint (required)

Optionalpublic

public?: boolean

Public listing flag

Optionalfeatured

featured?: boolean

Featured listing flag

Optionalactive

active?: boolean

Whether the entity is active

Optionalkeywords

keywords?: string[]

Optionaltags

tags?: string[]

Settings

Member Visibility

On This Page

Properties