Skip to main content

AgentSpec

Agent Runtimes

Agent Runtimes / types/agentspecs / AgentSpec

Interface: AgentSpec

Defined in: types/agentspecs.ts:23

Specification for an AI agent.

Defines the configuration for a reusable agent template that can be instantiated as an Agent Runtime.

Properties​

advanced?​

optional advanced?: AgentAdvancedConfig

Defined in: types/agentspecs.ts:89

Advanced settings (cost_limit, time_limit, max_iterations, validation)

authorizationPolicy?​

optional authorizationPolicy?: string

Defined in: types/agentspecs.ts:91

Authorization policy

codemode?​

optional codemode?: AgentCodemodeConfig

Defined in: types/agentspecs.ts:85

Codemode configuration (enabled, token_reduction, speedup)

color?​

optional color?: string

Defined in: types/agentspecs.ts:57

Theme color for the agent (hex code)

description​

description: string

Defined in: types/agentspecs.ts:31

Agent description

emoji?​

optional emoji?: string

Defined in: types/agentspecs.ts:55

Emoji identifier for the agent

enabled​

enabled: boolean

Defined in: types/agentspecs.ts:39

Whether the agent is enabled

environmentName​

environmentName: string

Defined in: types/agentspecs.ts:51

Runtime environment name for this agent

evals?​

optional evals?: AgentEvalConfig[]

Defined in: types/agentspecs.ts:83

Evaluation configurations

frontendTools?​

optional frontendTools?: FrontendToolSpec[]

Defined in: types/agentspecs.ts:49

Frontend tool sets available to this agent

goal?​

optional goal?: string

Defined in: types/agentspecs.ts:69

User-facing objective for the agent

guardrails?​

optional guardrails?: GuardrailSpec[]

Defined in: types/agentspecs.ts:81

Guardrail configurations

icon?​

optional icon?: string

Defined in: types/agentspecs.ts:53

Icon identifier or URL for the agent

id​

id: string

Defined in: types/agentspecs.ts:25

Unique agent identifier

mcpServers​

mcpServers: MCPServer[]

Defined in: types/agentspecs.ts:43

MCP servers used by this agent

mcpServerTools?​

optional mcpServerTools?: AgentMCPServerToolConfig[]

Defined in: types/agentspecs.ts:79

MCP server tool configurations with approval settings

memory?​

optional memory?: string

Defined in: types/agentspecs.ts:95

Memory backend identifier (e.g., 'ephemeral', 'mem0', 'memu', 'simplemem')

model?​

optional model?: string

Defined in: types/agentspecs.ts:41

AI model identifier to use for this agent

modelConfig?​

optional modelConfig?: AgentModelConfig

Defined in: types/agentspecs.ts:77

Model configuration (temperature, max_tokens)

name​

name: string

Defined in: types/agentspecs.ts:29

Display name for the agent

notifications?​

optional notifications?: AgentNotificationConfig

Defined in: types/agentspecs.ts:93

Notification configuration (email, slack)

output?​

optional output?: AgentOutputConfig

Defined in: types/agentspecs.ts:87

Output configuration (type/formats, template)

protocol?​

optional protocol?: string

Defined in: types/agentspecs.ts:71

Communication protocol (e.g., 'ag-ui', 'acp', 'a2a', 'vercel-ai')

sandboxVariant?​

optional sandboxVariant?: string

Defined in: types/agentspecs.ts:67

Sandbox variant to use for this agent ('local-eval', 'jupyter', 'local-jupyter')

skills​

skills: SkillSpec[]

Defined in: types/agentspecs.ts:45

Skills available to this agent

suggestions?​

optional suggestions?: string[]

Defined in: types/agentspecs.ts:59

Chat suggestions to show users what this agent can do

systemPrompt?​

optional systemPrompt?: string

Defined in: types/agentspecs.ts:33

System prompt for the agent

systemPromptCodemodeAddons?​

optional systemPromptCodemodeAddons?: string

Defined in: types/agentspecs.ts:35

System prompt addons when codemode is enabled

tags​

tags: string[]

Defined in: types/agentspecs.ts:37

Tags for categorization

tools?​

optional tools?: ToolSpec[]

Defined in: types/agentspecs.ts:47

Runtime tools available to this agent

trigger?​

optional trigger?: AgentTriggerConfig

Defined in: types/agentspecs.ts:75

Trigger configuration (type, cron, event source, prompt)

uiExtension?​

optional uiExtension?: string

Defined in: types/agentspecs.ts:73

UI extension type (e.g., 'a2ui', 'mcp-apps')

version?​

optional version?: string

Defined in: types/agentspecs.ts:27

Version

welcomeDocument?​

optional welcomeDocument?: string

Defined in: types/agentspecs.ts:65

Path to Lexical document to show on agent creation

welcomeMessage?​

optional welcomeMessage?: string

Defined in: types/agentspecs.ts:61

Welcome message shown when agent starts

welcomeNotebook?​

optional welcomeNotebook?: string

Defined in: types/agentspecs.ts:63

Path to Jupyter notebook to show on agent creation