API
API
Interfaces
AICommand

AICommand

LLM이 호출할 수 있는 명령(도구)의 정의.
모델에 등록되면 구현부에서 JSONSchema 기반 function/tool 정의로 변환되어 LLM에 전달된다.

See Also

https://json-schema.org/ (opens in a new tab)

Properties

description: string (opens in a new tab) readonly

LLM이 명령의 용도·호출 시점을 판단하는 근거. function calling 품질을 좌우하므로 필수이다.

default: undefined

examples: Array (opens in a new tab)<AIToolExample> readonly

호출 패턴을 알려주는 few-shot 예시.
변환 시 description에 합쳐져 LLM의 인자 채우기 정확도를 높인다.

default: undefined

name: string (opens in a new tab) readonly

default: undefined

parameters: Array (opens in a new tab)<AIToolParameter> readonly

default: undefined

readOnly: boolean (opens in a new tab) readonly

조회 전용(상태를 변경하지 않는) 명령 표식.
MCP 노출 시 표준 tool annotations(readOnlyHint)로 전달돼, 클라이언트가 도구 성격(조회/변경)을 표시·판단하는 근거가 된다.

default: undefined