Skip to content

Forra

ToolDefinition

Forra

Home
Using Forra as an LLM
Using Forra as an LLM
- OpenAI Compatibility
- Anthropic Compatibility
Integrating Forra
Integrating Forra
- REST API
  REST API
  - Overview
  - Reference
    Reference
    
    All endpoints
    
    Assistants
    
    Audio
    
    Auth
    
    Automations
    
    Chat
    
    Conversations
    
    Embeddings
    
    External (OAuth)
    
    External services visibility
    
    Groups
    
    Health
    
    Image
    
    Marketplace
    
    Memories
    
    Notifications
    
    Projects
    
    Protected
    
    Search
    
    Skills
    
    Users
    
    Utils
    
    Video
    
    Vision
    
    Shared schemas
- Python SDK
  Python SDK
- JavaScript SDK
  JavaScript SDK
Administration
Administration
- Overview
- API tokens
- Authentication
  Authentication
  - Microsoft
  - Google
  - Okta
  - Auth0
- External services
  External services
  - Overview
  - Google
  - Microsoft
  - Custom
- Knowledge sources
  Knowledge sources
  - Allowed file types
- User management
  User management
- Models
  Models
  - Selecting models
  - Custom API keys
- Spending
  Spending
Extending Forra
Extending Forra
- Forra CLI
- Assistants
- Skills
  Skills
  - Overview
  - Global Skills
  - Functions
    Functions
    
    Getting Started
    
    Function Types
    
    Deployment
- Applications

@mirego/forra-api

@mirego/forra-api / tools / ToolDefinition

Interface: ToolDefinition

Properties

callable()

callable: (args) => unknown

Parameters

args

Record\<string, unknown>

Returns

unknown

description

description: string

params

params: ToolParameter[]