ConfigSettingsToolset.ConfigSettingsToolset

Tools for listing, inspecting, and editing Config Settings sections

8 tool(s).

ConfigSettingsToolset.ConfigSettingsToolset.GetSectionPropertyValues

Returns the current values of the specified properties as a JSON object. Raises an error if the section does not exist, has no settings object, or any requested property cannot be read.

Input schema

{
  "properties": {
    "categoryName": {
      "description": "The name of the category (e.g. \"Engine\").",
      "type": "string"
    },
    "containerName": {
      "description": "The name of the container (e.g. \"Project\").",
      "type": "string"
    },
    "propertyNames": {
      "description": "The names of the properties to read.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "sectionName": {
      "description": "The name of the section (e.g. \"General\").",
      "type": "string"
    }
  },
  "required": [
    "containerName",
    "categoryName",
    "sectionName",
    "propertyNames"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "JSON object mapping property names to their current values, or empty string on failure.",
      "type": "string"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

ConfigSettingsToolset.ConfigSettingsToolset.GetSectionSchema

Returns a JSON Schema describing the user-visible properties of a settings section. The schema maps each property name to its type, description, and constraints. Raises an error if the section does not exist or has no backing settings object (e.g. uses a custom widget instead).

Input schema

{
  "properties": {
    "categoryName": {
      "description": "The name of the category (e.g. \"Engine\").",
      "type": "string"
    },
    "containerName": {
      "description": "The name of the container (e.g. \"Project\").",
      "type": "string"
    },
    "sectionName": {
      "description": "The name of the section (e.g. \"General\").",
      "type": "string"
    }
  },
  "required": [
    "containerName",
    "categoryName",
    "sectionName"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "JSON Schema string describing the section's properties, or empty string on failure.",
      "type": "string"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

ConfigSettingsToolset.ConfigSettingsToolset.ListCategories

Lists the names of all categories within a settings container, sorted alphabetically. Raises an error if the container does not exist.

Input schema

{
  "properties": {
    "containerName": {
      "description": "The name of the container (e.g. \"Project\").",
      "type": "string"
    }
  },
  "required": [
    "containerName"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "Sorted array of category names.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

ConfigSettingsToolset.ConfigSettingsToolset.ListContainers

Lists the names of all known settings containers, sorted alphabetically. Common containers are "Editor" and "Project".

Input schema

{
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "Sorted array of container names.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

ConfigSettingsToolset.ConfigSettingsToolset.ListSections

Lists the names of all sections within a settings category, sorted alphabetically. Raises an error if the container or category does not exist.

Input schema

{
  "properties": {
    "categoryName": {
      "description": "The name of the category (e.g. \"Engine\").",
      "type": "string"
    },
    "containerName": {
      "description": "The name of the container (e.g. \"Project\").",
      "type": "string"
    }
  },
  "required": [
    "containerName",
    "categoryName"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "Sorted array of section names.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

ConfigSettingsToolset.ConfigSettingsToolset.ResetSectionToDefaults

Resets the settings in a section to their default values. Raises an error if the section does not exist or reset is not supported.

Input schema

{
  "properties": {
    "categoryName": {
      "description": "The name of the category (e.g. \"Engine\").",
      "type": "string"
    },
    "containerName": {
      "description": "The name of the container (e.g. \"Project\").",
      "type": "string"
    },
    "sectionName": {
      "description": "The name of the section (e.g. \"General\").",
      "type": "string"
    }
  },
  "required": [
    "containerName",
    "categoryName",
    "sectionName"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "True on success.",
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

ConfigSettingsToolset.ConfigSettingsToolset.SaveSection

Saves the settings in a section. Raises an error if the section does not exist or saving is not supported.

Input schema

{
  "properties": {
    "categoryName": {
      "description": "The name of the category (e.g. \"Engine\").",
      "type": "string"
    },
    "containerName": {
      "description": "The name of the container (e.g. \"Project\").",
      "type": "string"
    },
    "sectionName": {
      "description": "The name of the section (e.g. \"General\").",
      "type": "string"
    }
  },
  "required": [
    "containerName",
    "categoryName",
    "sectionName"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "True on success.",
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

ConfigSettingsToolset.ConfigSettingsToolset.SetSectionProperties

Sets one or more properties on a settings section from a JSON object and saves. PropertiesJson must be a JSON object mapping property names to new values, in the same format returned by GetSectionPropertyValues. Raises an error if the section does not exist, cannot be edited, has no settings object, the default config file is not writable, or any property cannot be set.

Input schema

{
  "properties": {
    "categoryName": {
      "description": "The name of the category (e.g. \"Engine\").",
      "type": "string"
    },
    "containerName": {
      "description": "The name of the container (e.g. \"Project\").",
      "type": "string"
    },
    "propertiesJson": {
      "description": "JSON object with property name to new value pairs.",
      "type": "string"
    },
    "sectionName": {
      "description": "The name of the section (e.g. \"General\").",
      "type": "string"
    }
  },
  "required": [
    "containerName",
    "categoryName",
    "sectionName",
    "propertiesJson"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "True if all properties successfully set.",
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}