PropertyBase — Common Base Fields

All Property types share the following base fields:

interface PropertyBase {
  /** Required. Unique identifier for the parameter, used for data access. */
  name: string

  /** Optional. Label name displayed in the form. */
  display_name?: I18nText

  /** Optional. Whether the parameter is required. Default: false. */
  required?: boolean

  /** Optional. Conditional show/hide rules. */
  display?: {
    show?: DisplayCondition // Show when condition is true
    hide?: DisplayCondition // Hide when condition is true
  }

  /** Optional. AI-related configuration. */
  ai?: {
    /** Parameter description for LLM, helping AI understand parameter purpose. */
    llm_description?: I18nText
  }

  /** Optional. UI component configuration. Different types support different UI components. */
  ui?: PropertyUI

  /** Optional. Upstream parameter dependencies for cascading resource fields. */
  depends_on?: string[]

  /** Optional. Hub-side decoder applied before the value reaches your plugin. */
  decoder?: "json"
}

Field Description:

Field	Required	Description
name	✅	Parameter path identifier. Only alphanumeric and underscore.
display_name	❌	Form label. Uses humanized name if not provided.
required	❌	Mark as required; form will show required indicator.
display	❌	Conditional visibility. See Section 9.
ai	❌	Parameter description when AI Agent calls tool.
ui	❌	Uses type's default UI component if not provided.
depends_on	❌	Upstream property names for cascading behavior. Currently supported on resource_locator and resource_mapper.
decoder	❌	Hub-side decoder. Currently only "json" is supported, and it is intended for object properties.

depends_on is only supported on resource_locator and resource_mapper today. Use decoder: "json" when the Hub should parse an incoming JSON string into an object before invoking your plugin.