Skip to main content
Glama

Set the project's share image from the user's open R3 editor

r3_editor_set_preview_image
DestructiveIdempotent

Use what the project's camera shows NOW, in the user's open R3 editor, as the project's share image: the picture its live page, link previews (social cards) and the showcase show, used when the project is next published (r3_publish_live, or Publish update in the editor). The editor waits until the scene's textures have loaded and takes it without edit aids (no grid, gizmos or outlines), as a visitor sees it; the answer is the picture it set. It is for once the project looks right (r3_editor_capture shows it beforehand), or when the user asks for a new picture. A live page keeps the share image of its live release until that next publish. Needs a tab with the project open and project:write.

Input Schema

NameRequiredDescriptionDefault
projectIdYesA project open in the user's editor (r3_whoami lists them).

Output Schema

NameRequiredDescriptionDefault
bytesYes
savedYes
widthYes
answerYesThis answer in words: what was done, what R3 measured, decided or refused, and what to do next. The same text as the result's text block. Read it: the fields beside it are the data, this is the guidance.
editorYes
heightYes
mimeTypeYes
projectIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / properties / editor / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "lastActiveAgoMs": {
      -        "type": "number"
      -      },
      -      "lastActiveAt": {
      -        "type": "string"
      -      },
      -      "openProjects": {
      -        "anyOf": [
      -          {
      -            "items": {
      -              "additionalProperties": false,
      -              "properties": {
      -                "id": {
      -                  "type": "string"
      -                },
      -                "name": {
      -                  "type": [
      -                    "string",
      -                    "null"
      -                  ]
      -                }
      -              },
      -              "required": [
      -                "id",
      -                "name"
      -              ],
      -              "type": "object"
      -            },
      -            "type": "array"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "openedAt": {
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      }
      -    },
      -    "required": [
      -      "openedAt",
      -      "lastActiveAt",
      -      "lastActiveAgoMs",
      -      "openProjects"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "frames": {
      +        "anyOf": [
      +          {
      +            "additionalProperties": false,
      +            "properties": {
      +              "advancing": {
      +                "type": "boolean"
      +              },
      +              "frameSeen": {
      +                "type": "boolean"
      +              },
      +              "sceneShown": {
      +                "type": "boolean"
      +              },
      +              "visible": {
      +                "type": "boolean"
      +              }
      +            },
      +            "required": [
      +              "advancing",
      +              "visible",
      +              "sceneShown",
      +              "frameSeen"
      +            ],
      +            "type": "object"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "lastActiveAgoMs": {
      +        "type": "number"
      +      },
      +      "lastActiveAt": {
      +        "type": "string"
      +      },
      +      "openProjects": {
      +        "anyOf": [
      +          {
      +            "items": {
      +              "additionalProperties": false,
      +              "properties": {
      +                "id": {
      +                  "type": "string"
      +                },
      +                "name": {
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                }
      +              },
      +              "required": [
      +                "id",
      +                "name"
      +              ],
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "openedAt": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      }
      +    },
      +    "required": [
      +      "openedAt",
      +      "lastActiveAt",
      +      "lastActiveAgoMs",
      +      "openProjects"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
  2. Added

TDQS

A4.3/5.0
Behavior4/5

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

Adds real context beyond annotations: it waits for textures to load, excludes edit aids (grid, gizmos, outlines), returns the picture it set, and notes a live page keeps its old share image until the next publish. The overwrite of a previously set share image (which underlies destructiveHint=true) is only implied, not stated.

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?

Purpose is front-loaded and every clause carries information, though the first sentence is a long chain of appositives that could be split for readability. No filler or restatement of the name.

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?

An output schema exists, so return values need not be explained, and the description still covers timing, permissions, and publish coupling. The one missing piece is an explicit statement that an existing share image is replaced, which matters given the destructive annotation.

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

Parameters3/5

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

Schema coverage is 100% and the single projectId parameter is already documented as 'a project open in the user's editor'. The description only reinforces that an open editor tab is required, adding little beyond the schema.

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

Purpose5/5

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

States a specific verb and resource: use what the camera shows NOW in the open R3 editor as the project's share image, and names exactly where that image surfaces (live page, link previews, showcase). It distinguishes itself from r3_editor_capture (preview beforehand) and ties the result to r3_publish_live.

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

Usage Guidelines5/5

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

Gives explicit trigger conditions ('once the project looks right', 'when the user asks for a new picture') and names the alternative tool (r3_editor_capture) for checking the view first. The prerequisite of an open editor tab plus project:write is spelled out.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources