read_project

What it does

• Read-only
• Idempotent
• Account required

What the designer actually changed. This returns the project file itself: the frame order they settled on, the caption words they typed for each locale, the locale list and the styling. It also answers whether the project holds its own screenshots, which decides whether render needs anything attached at all, and names the App Store app the project is linked to when it has one. With geometry: true it also lays the strip out once and returns every device’s box in strip pixels, the frames it reaches, its layer and every overlap. Read-only, and it never returns screenshot bytes.

You can ask: “Check whether the Tidebook project can render with nothing attached.”

Input

• projectstringoptionalat least 1 character

  Project id or exact name. Omit for the most recently edited project.

• geometrybooleanoptional

  true: also lay the strip out and return geometry — every device's box in strip px, the frames it reaches, z, hidden, and every overlap. Costs one layout render.

Result

• okbooleanoptional

• savedbooleanoptional

  false: nothing was found; candidates lists the projects that exist.

• projectobjectoptional

  • idstringrequired

  • namestringrequired

• updatedAtstring or nulloptional

• screenshotsobjectoptional

• project_fileobjectoptional

• layoutobjectoptional

• geometryobjectoptional

• candidatesarrayoptional

  each item

  object

• notestringoptional

  Advisories: fallbacks, clamps, downgrades. Never an error.

• messagestringoptional

Example

That request maps to this call:

{
  "name": "read_project",
  "arguments": {
    "project": "Tidebook 2.4 launch"
  }
}

The project file, its updatedAt stamp, and a screenshots block whose available flag tells you whether render can run it with no screenshots argument.

Access and cost

• Needs an account. Not available to an anonymous hosted caller.
• Free. Reading spends no cloud credits.

When it refuses

You want to know whether the strip changed since last time.

Remember updatedAt and compare on the next read. A newer value means somebody edited it.

You were about to ask the user to re-upload their screenshots.

Check the screenshots block first. If it says they are available, render needs nothing from the conversation.

Where this fits

• Reading before editing
• Polling a project from CI

What the agent is told

The title and description the server publishes on tools/list — this is the copy a model chooses between, reproduced verbatim.