Skip to main content

Agent

interface

A declared agent, as returned by agent.

interface Agent

Import

import { Agent } from '@modular/sdk';

Members6

description
string

What this agent is good for. Shown to the user and read by the model when routing.

kind
'agent'
modeloptional
string

Pin a model, for example `claude-agent-sdk/claude-sonnet-4-6`. Inherits the session's model when omitted.

name
string

Short identifier. The callable agent id is `<extensionId>/<name>`.

prompt
string | Prompt

The system prompt, either inline text or a Prompt shared with the composer.

toolsoptional
readonly string[]

Leave this off. Declared tool allowlists are not executable yet, and even an empty array throws at activation.

Notes

category
Authoring