Skip to main content
Glama

Inpaint an image (1.x name)

ideogram_edit

Edit images by inpainting selected areas using Ideogram V3 models; acts as a deprecated alias for 1.x callers with the same arguments as its replacement.

Instructions

Deprecated alias of ideogram_inpaint, kept through 2.x for 1.x callers: the same arguments and models (see ideogram_inpaint's schema).

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed16 schema fields changedv2.5.0
    • changedInput schema / additionalProperties
      Previous value: -falseNew value: +{}
    • removedInput schema / properties / character_reference_image
      Removed value: -{
      -  "description": "Local image file of a character to keep consistent (one image; Ideogram bills character references at its own rate)",
      -  "minLength": 1,
      -  "type": "string"
      -}
    • removedInput schema / properties / character_reference_mask
      Removed value: -{
      -  "description": "Grayscale mask of the character reference (same dimensions); needs character_reference_image",
      -  "minLength": 1,
      -  "type": "string"
      -}
    • removedInput schema / properties / color_palette
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "additionalProperties": false,
      -      "properties": {
      -        "name": {
      -          "description": "A preset palette",
      -          "enum": [
      -            "EMBER",
      -            "FRESH",
      -            "JUNGLE",
      -            "MAGIC",
      -            "MELON",
      -            "MOSAIC",
      -            "PASTEL",
      -            "ULTRAMARINE"
      -          ],
      -          "type": "string"
      -        }
      -      },
      -      "required": [
      -        "name"
      -      ],
      -      "type": "object"
      -    },
      -    {
      -      "additionalProperties": false,
      -      "properties": {
      -        "members": {
      -          "description": "Explicit colours, most dominant first",
      -          "items": {
      -            "additionalProperties": false,
      -            "properties": {
      -              "color_hex": {
      -                "description": "The colour, #RRGGBB",
      -                "pattern": "^#[0-9A-Fa-f]{6}$",
      -                "type": "string"
      -              },
      -              "color_weight": {
      -                "description": "Its share of the palette (0.05-1)",
      -                "maximum": 1,
      -                "minimum": 0.05,
      -                "type": "number"
      -              }
      -            },
      -            "required": [
      -              "color_hex"
      -            ],
      -            "type": "object"
      -          },
      -          "maxItems": 10,
      -          "minItems": 1,
      -          "type": "array"
      -        }
      -      },
      -      "required": [
      -        "members"
      -      ],
      -      "type": "object"
      -    }
      -  ],
      -  "description": "A preset palette by name, or explicit colours with weights (not both)"
      -}
    • removedInput schema / properties / image
      Removed value: -{
      -  "description": "Local file path of the source image to edit",
      -  "minLength": 1,
      -  "type": "string"
      -}
    • removedInput schema / properties / magic_prompt
      Removed value: -{
      -  "description": "Auto-enhance prompts (default: AUTO)",
      -  "enum": [
      -    "AUTO",
      -    "ON",
      -    "OFF"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / properties / mask
      Removed value: -{
      -  "description": "Local file path of the mask image (black = regions to edit, white = keep)",
      -  "minLength": 1,
      -  "type": "string"
      -}
    • removedInput schema / properties / num_images
      Removed value: -{
      -  "description": "Number of variations (1-8, default: 1)",
      -  "maximum": 8,
      -  "minimum": 1,
      -  "type": "integer"
      -}
    • removedInput schema / properties / prompt
      Removed value: -{
      -  "description": "Description of desired changes",
      -  "maxLength": 10000,
      -  "minLength": 1,
      -  "type": "string"
      -}
    • removedInput schema / properties / rendering_speed
      Removed value: -{
      -  "description": "Speed/quality tradeoff (default: DEFAULT)",
      -  "enum": [
      -    "FLASH",
      -    "TURBO",
      -    "DEFAULT",
      -    "QUALITY"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / properties / seed
      Removed value: -{
      -  "description": "Reproducibility seed",
      -  "maximum": 2147483647,
      -  "minimum": 0,
      -  "type": "integer"
      -}
    • removedInput schema / properties / style_codes
      Removed value: -{
      -  "description": "8-character hexadecimal style codes from Ideogram",
      -  "items": {
      -    "pattern": "^[0-9A-Fa-f]{8}$",
      -    "type": "string"
      -  },
      -  "maxItems": 8,
      -  "minItems": 1,
      -  "type": "array"
      -}
    • removedInput schema / properties / style_preset
      Removed value: -{
      -  "description": "A named style preset as Ideogram lists them",
      -  "maxLength": 100,
      -  "minLength": 1,
      -  "type": "string"
      -}
    • removedInput schema / properties / style_reference_images
      Removed value: -{
      -  "description": "Local image files whose style the result follows (up to 3, 25 MB each)",
      -  "items": {
      -    "minLength": 1,
      -    "type": "string"
      -  },
      -  "maxItems": 3,
      -  "minItems": 1,
      -  "type": "array"
      -}
    • removedInput schema / properties / style_type
      Removed value: -{
      -  "description": "Visual style (the API default is GENERAL when omitted)",
      -  "enum": [
      -    "AUTO",
      -    "GENERAL",
      -    "REALISTIC",
      -    "DESIGN",
      -    "FICTION"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / required
      Removed value: -[
      -  "image",
      -  "mask",
      -  "prompt"
      -]
  2. Changed9 schema fields changedv1.2.0
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / character_reference_image
      Added value: +{
      +  "description": "Local image file of a character to keep consistent (one image; Ideogram bills character references at its own rate)",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / character_reference_mask
      Added value: +{
      +  "description": "Grayscale mask of the character reference (same dimensions); needs character_reference_image",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / color_palette
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": false,
      +      "properties": {
      +        "name": {
      +          "description": "A preset palette",
      +          "enum": [
      +            "EMBER",
      +            "FRESH",
      +            "JUNGLE",
      +            "MAGIC",
      +            "MELON",
      +            "MOSAIC",
      +            "PASTEL",
      +            "ULTRAMARINE"
      +          ],
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "name"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "additionalProperties": false,
      +      "properties": {
      +        "members": {
      +          "description": "Explicit colours, most dominant first",
      +          "items": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "color_hex": {
      +                "description": "The colour, #RRGGBB",
      +                "pattern": "^#[0-9A-Fa-f]{6}$",
      +                "type": "string"
      +              },
      +              "color_weight": {
      +                "description": "Its share of the palette (0.05-1)",
      +                "maximum": 1,
      +                "minimum": 0.05,
      +                "type": "number"
      +              }
      +            },
      +            "required": [
      +              "color_hex"
      +            ],
      +            "type": "object"
      +          },
      +          "maxItems": 10,
      +          "minItems": 1,
      +          "type": "array"
      +        }
      +      },
      +      "required": [
      +        "members"
      +      ],
      +      "type": "object"
      +    }
      +  ],
      +  "description": "A preset palette by name, or explicit colours with weights (not both)"
      +}
    • changedInput schema / properties / mask / description
      Previous value: -"Local file path of the mask image (black=edit, white=keep, min 10% black)"New value: +"Local file path of the mask image (black = regions to edit, white = keep)"
    • addedInput schema / properties / style_codes
      Added value: +{
      +  "description": "8-character hexadecimal style codes from Ideogram",
      +  "items": {
      +    "pattern": "^[0-9A-Fa-f]{8}$",
      +    "type": "string"
      +  },
      +  "maxItems": 8,
      +  "minItems": 1,
      +  "type": "array"
      +}
    • addedInput schema / properties / style_preset
      Added value: +{
      +  "description": "A named style preset as Ideogram lists them",
      +  "maxLength": 100,
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / style_reference_images
      Added value: +{
      +  "description": "Local image files whose style the result follows (up to 3, 25 MB each)",
      +  "items": {
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  "maxItems": 3,
      +  "minItems": 1,
      +  "type": "array"
      +}
    • changedInput schema / properties / style_type / description
      Previous value: -"Visual style (default: AUTO)"New value: +"Visual style (the API default is GENERAL when omitted)"
  3. First observedv1.0.3

TDQS

A3.7/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description must carry full behavioral disclosure. It discloses deprecation and equivalence to ideogram_inpaint, but omits the actual action, side effects, permissions, or reversibility, leaving the agent to consult the referenced tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single, front-loaded sentence that delivers the deprecation status, compatibility window, and pointer to the canonical schema with no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a deprecated alias with no parameters and no output schema, the description provides enough to route the agent: deprecation, compatibility window, argument equivalence, and schema reference. A direct operation statement is left to the title.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema is empty (0 parameters). The description notes arguments and models are the same as ideogram_inpaint and points to its schema, which is valuable since this schema carries no field definitions. Baseline for 0 params is 4.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states it is a deprecated alias of ideogram_inpaint, which clearly defines its role and distinguishes it from siblings. However, it does not state the actual operation (inpainting an image) in the description itself, relying on the title and the referenced tool.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Specifies it is kept through 2.x for 1.x callers, clearly indicating the narrow backward-compatibility use case. It implies new callers should use ideogram_inpaint, though it does not explicitly forbid use or name the alternative in a directive sentence.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.