Skip to main content

Error Codes

This page is the canonical error taxonomy for framework runtime failures.

Error Catalog

Error ClassCodeTypical Trigger
ToolNotFoundErrorAIFW_TOOL_NOT_FOUNDmodel requested a tool that is not registered
ToolValidationErrorAIFW_TOOL_VALIDATION_ERRORtool args failed schema validation
ModelErrorAIFW_MODEL_ERRORprovider/model invocation failed
MaxStepsExceededErrorAIFW_MAX_STEPS_EXCEEDEDagent exceeded configured maxSteps
PromptTemplateErrorAIFW_PROMPT_TEMPLATE_ERRORrequired prompt variable missing/invalid
OutputParserErrorAIFW_OUTPUT_PARSER_ERRORparser failed to transform model output

Handling Guidance

  • Treat error code as the stable programmatic identifier.
  • Treat error message as human-facing and not API-stable.
  • Preserve cause when rethrowing framework errors.
  • Log both name and code for diagnostics.

Compatibility Notes

  • New error codes can be added in minor versions.
  • Removing or changing existing codes requires a breaking release and contract version update.