Skip to main content
Glama

Describe an image

ideogram_describe

Convert an image into a text description or structured JSON prompt for Ideogram 3.0/4.0, using a local file, public HTTPS URL, or existing Ideogram asset.

Instructions

Describe an image in words (Ideogram 3.0) or as a structured JSON prompt (Ideogram 4.0). Takes a local file, a public https URL or an Ideogram asset. Describe has no price quote (the API offers no dry run for it).

Input Schema

NameRequiredDescriptionDefault
imageNoLocal image file to work on, or a public https URL of one
modelNoThe model (default ideogram-3); each takes the fields of its variant below
wait_sNoSeconds to wait for the result (0-50, default 45). The job is accepted first; if it is still running when the wait ends, the result is its generation_id for ideogram_generation (never resubmitted, never billed twice).
inline_imagesNotrue: each saved image is also returned as image content (base64; one over 3.75 MB, or past 10 MB in total, by path only), for a client without file access
describe_model_versionNo1.x name of the model, deprecated: V_3 = model ideogram-3
image_asset_identifierNoAn Ideogram asset (an upload or an earlier result) instead of a local image

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed12 schema fields changedv2.5.0
    • addedInput schema / additionalProperties
      Added value: +{}
    • addedInput schema / definitions
      Added value: +{
      +  "__schema0": {
      +    "properties": {
      +      "asset_id": {
      +        "type": "string"
      +      },
      +      "asset_type": {
      +        "enum": [
      +          "ASSET",
      +          "CANVAS_ASSET",
      +          "LAYERED_ASSET",
      +          "RESPONSE",
      +          "UPLOAD"
      +        ],
      +        "type": "string"
      +      },
      +      "collection_id": {
      +        "maxLength": 22,
      +        "minLength": 22,
      +        "pattern": "^[A-Za-z0-9_-]{22}$",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "asset_id",
      +      "asset_type"
      +    ],
      +    "type": "object"
      +  }
      +}
    • addedInput schema / oneOf
      Added value: +[
      +  {
      +    "properties": {
      +      "image": {
      +        "type": "string"
      +      },
      +      "image_asset_identifier": {
      +        "$ref": "#/definitions/__schema0"
      +      },
      +      "model": {
      +        "const": "ideogram-3",
      +        "type": "string"
      +      }
      +    },
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "image": {
      +        "type": "string"
      +      },
      +      "image_asset_identifier": {
      +        "$ref": "#/definitions/__schema0"
      +      },
      +      "include_bbox": {
      +        "default": true,
      +        "type": "boolean"
      +      },
      +      "include_style_descriptions": {
      +        "default": false,
      +        "type": "boolean"
      +      },
      +      "include_tags": {
      +        "default": false,
      +        "type": "boolean"
      +      },
      +      "model": {
      +        "const": "ideogram-4",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "model"
      +    ],
      +    "type": "object"
      +  }
      +]
    • changedInput schema / properties / describe_model_version / description
      Previous value: -"Model version to use (default: V_3)"New value: +"1.x name of the model, deprecated: V_3 = model ideogram-3"
    • changedInput schema / properties / image / description
      Previous value: -"Local file path of the image to describe"New value: +"Local image file to work on, or a public https URL of one"
    • removedInput schema / properties / image / minLength
      Removed value: -1
    • removedInput schema / properties / image / type
      Removed value: -"string"
    • addedInput schema / properties / image_asset_identifier
      Added value: +{
      +  "description": "An Ideogram asset (an upload or an earlier result) instead of a local image"
      +}
    • addedInput schema / properties / inline_images
      Added value: +{
      +  "description": "true: each saved image is also returned as image content (base64; one over 3.75 MB, or past 10 MB in total, by path only), for a client without file access",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / model
      Added value: +{
      +  "description": "The model (default ideogram-3); each takes the fields of its variant below",
      +  "enum": [
      +    "ideogram-3",
      +    "ideogram-4"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / wait_s
      Added value: +{
      +  "description": "Seconds to wait for the result (0-50, default 45). The job is accepted first; if it is still running when the wait ends, the result is its generation_id for ideogram_generation (never resubmitted, never billed twice).",
      +  "maximum": 50,
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • removedInput schema / required
      Removed value: -[
      -  "image"
      -]
  2. First observedv1.0.3

TDQS

A3.7/5.0
Behavior4/5

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

No annotations are supplied, so the description must carry behavioral load, and it does disclose two non-obvious traits: the output format depends on the model (words vs structured JSON), and there is no dry-run/price quote for this operation. It stops short of auth needs, rate limits, or return-shape detail.

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

Conciseness4/5

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

Three short sentences with the core purpose front-loaded. The parenthetical model-versioning and the pricing aside are slightly digressive but each carries information an agent needs, so the size is justified.

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

Completeness3/5

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

For a 6-parameter tool with branchy oneOf variants and no output schema, the definition is adequate but thin: it never characterizes the return value beyond 'words' or 'structured JSON prompt,' and leaves the ideogram-4 flags (include_bbox, include_tags, include_style_descriptions) entirely to the schema. Nothing critical is missing, but the description does not fully compensate for the absent output schema.

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 coverage is already 100%, so the baseline is 3, but the description adds meaning the schema lacks: it states the accepted input sources (local file, public https URL, Ideogram asset) and, more importantly, that the 'model' value determines the output form. That is genuine added value over the variant schema, which only says 'each takes the fields of its variant below.'

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?

States a specific verb and resource ('Describe an image') and crucially distinguishes the two model modes: Ideogram 3.0 returns words while 4.0 returns a structured JSON prompt. It does not, however, name or differentiate itself from near siblings such as ideogram_magic_prompt or ideogram_generation.

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

Usage Guidelines3/5

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

Usage is only implied by the operation itself. The one routing hint given is indirect ('Describe has no price quote'), which tells the agent not to expect pricing but does not say when to choose describe over other text-producing or generation tools.

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