Add realm.cards.get to the realm runner by jurgenwerk · Pull Request #6632 · cardstack/boxel

jurgenwerk · 2026-10-09T11:27:13Z

A script in run-realm-code could read a card only as its file, so it could not tell whether the card is indexed or why it fails to load. The model had to leave the script and call read-card-for-ai-assistant for that. Scripts can now call realm.cards.get(path).

It reads the indexed card through the store and serializes it the same way read-card-for-ai-assistant does: computed fields included, base64 images left out, every URL absolute.
It returns { path, id, adoptsFrom, attributes, relationships }. The path can be Person/x, Person/x.json, or a full URL in the run's realm.
A missing card fails with Card not found; a card in an error state fails with its error message. Like fs.list, it does not count toward the run's file limit.

The paired cardstack/boxel-skills#199 documents realm.cards.get and removes the declaration of read-card-for-ai-assistant. It merges after this change is deployed. The host tool stays until nothing calls it.

🤖 Generated with Claude Code

github-actions · 2026-10-09T11:38:57Z

Preview deployments

Host staging preview

Host production preview

Host Test Results

1 files ±0 1 suites ±0 1h 47m 4s ⏱️ + 15m 27s
5 401 tests ±0 5 390 ✅ ±0 11 💤 ±0 0 ❌ ±0
5 416 runs ±0 5 405 ✅ ±0 11 💤 ±0 0 ❌ ±0

Results for commit 009555a. ± Comparison against earlier commit 7ad5e90.

Realm Server Test Results

1 files ±0 319 suites ±0 1h 57m 16s ⏱️ + 2m 0s
5 113 tests +7 5 113 ✅ +7 0 💤 ±0 0 ❌ ±0
5 172 runs +7 5 172 ✅ +7 0 💤 ±0 0 ❌ ±0

Results for commit 009555a. ± Comparison against earlier commit 7ad5e90.

chatgpt-codex-connector · 2026-10-09T12:44:11Z

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review	Status	Commit	Review trigger
📝 Code Review	✅ Completed 2026-10-09T12:46:40.309671Z	`0423071`	Draft marked ready

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 04230714dc

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector · 2026-10-09T12:46:37Z

  }

+  private async readCard(id: string): Promise<LooseSingleCardDocument> {
+    let card = await this.store.get(id);


Bypass the store cache when reading cards

When the requested card is already loaded, store.get() returns the cached instance without fetching the indexed state. For example, after await realm.fs.replace('people/hassan.json', ...), an immediately following realm.cards.get('people/hassan') can serialize the pre-edit instance because the realm invalidation and store reload are asynchronous; the same issue occurs with locally modified cached instances. Use the store's uncached read path so this API consistently returns durable indexed data.

Useful? React with 👍 / 👎.

[Claude Code 🤖] Fixed in 7ad5e90: realm.cards.get now reads with store.getWithoutCache, as check-correctness does. The test reads a card, edits its file in the same run, and reads it again; with store.get the second read returned the old name.

Copilot

🟡 Changes recommended

Distinguish awaiting-index cards from missing cards and add the requested focused integration coverage.

1 open finding

Preserve awaitingIndex errors instead of reporting card not found · New

What changed in this PR

Adds realm.cards.get(path) to the realm runner for retrieving indexed cards with computed fields and absolute URLs.

Changes:

Adds host-side card lookup and serialization.
Exposes realm.cards.get through the worker API.
Adds integration coverage for card retrieval behavior.

File	Summary
`packages/host/tests/integration/tools/run-realm-code-test.gts`	Adds integration tests; focused coverage is still needed for image omission, indexed-card errors, and the file-limit exemption.
`packages/host/app/tools/run-realm-code.ts`	Implements lookup and serialization. Moderate issue: `awaitingIndex` is incorrectly reported as `Card not found`.
`packages/host/app/lib/realm-runner/worker.ts`	Exposes `realm.cards.get` to sandboxed scripts.
`packages/host/app/lib/realm-runner/types.ts`	Registers the new call type.

🧠 Review effort: Lite

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

jurgenwerk · 2026-10-12T07:34:57Z

+    let card = await this.store.get(id);
+    if (!isCardInstance(card)) {
+      throw new Error(
+        card.status === 404


[Claude Code 🤖] Fixed in 7ad5e90: a card awaiting index now fails with Card is not indexed yet: <id>; read it again in a moment, and only a plain 404 says Card not found.

richardhjtan

[Claude Code 🤖] One blocking finding, inline: realm.cards.get answers a card in a different shape from realm.cards.search, under the same realm.cards namespace.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

…ort cards awaiting index Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

jurgenwerk · 2026-10-12T09:26:58Z

[Claude Code 🤖] Tested by hand on a local stack, with this PR and the paired skills PR applied.

Read a card. Asked for a card's fields and links. The model called realm.cards.get in run-realm-code, not read-card-for-ai-assistant. The result includes the computed fields (cardTitle, cardDescription).

Missing card. realm.cards.get('HelloWorld/no-such-card') fails with Card not found: <realm>/HelloWorld/no-such-card, and the model reports the error.

Not covered yet: a card with links, to check that relationships holds absolute URLs.

jurgenwerk mentioned this pull request Oct 9, 2026

Document realm.cards.get and stop declaring read-card-for-ai-assistant cardstack/boxel-skills#199

Open

jurgenwerk force-pushed the cs-13475-realm-cards-get branch from 82f12e7 to 0423071 Compare October 9, 2026 11:33

jurgenwerk marked this pull request as ready for review October 9, 2026 12:43

jurgenwerk requested a review from a team October 9, 2026 12:44

chatgpt-codex-connector Bot reviewed Oct 9, 2026

View reviewed changes

habdelra requested a lite review from Copilot October 9, 2026 14:07

Copilot started reviewing on behalf of habdelra October 9, 2026 14:08 View session

Copilot AI reviewed Oct 9, 2026

View reviewed changes

richardhjtan reviewed Oct 9, 2026

View reviewed changes

Comment thread packages/host/app/tools/run-realm-code.ts Outdated

jurgenwerk and others added 2 commits October 12, 2026 09:31

Add realm.cards.get to the realm runner

67647aa

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Match realm.cards.search's card shape, read past the store cache, rep…

7ad5e90

…ort cards awaiting index Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

jurgenwerk force-pushed the cs-13475-realm-cards-get branch from 0423071 to 7ad5e90 Compare October 12, 2026 07:34

jurgenwerk requested review from a team and richardhjtan October 12, 2026 07:44

jurgenwerk and others added 2 commits October 12, 2026 11:26

Add manual test screenshots for the PR description

3aca590

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Remove manual test screenshots

009555a

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Navigation Menu

Repository navigation

Add realm.cards.get to the realm runner - #6632

Add realm.cards.get to the realm runner#6632
jurgenwerk wants to merge 4 commits into
mainfrom
cs-13475-realm-cards-get

jurgenwerk commented Oct 9, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 9, 2026 •

edited

Loading

Uh oh!

chatgpt-codex-connector Bot commented Oct 9, 2026 •

edited

Loading

Uh oh!

chatgpt-codex-connector Bot left a comment

Uh oh!

chatgpt-codex-connector Bot Oct 9, 2026

Uh oh!

jurgenwerk Oct 12, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

jurgenwerk Oct 12, 2026

Uh oh!

richardhjtan left a comment

Uh oh!

Uh oh!

jurgenwerk commented Oct 12, 2026

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

jurgenwerk commented Oct 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Oct 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Preview deployments

Host Test Results

Realm Server Test Results

Uh oh!

chatgpt-codex-connector Bot commented Oct 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codex Review Summary

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

chatgpt-codex-connector Bot Oct 9, 2026

Choose a reason for hiding this comment

Uh oh!

jurgenwerk Oct 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

jurgenwerk Oct 12, 2026

Choose a reason for hiding this comment

Uh oh!

richardhjtan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jurgenwerk commented Oct 12, 2026

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jurgenwerk commented Oct 9, 2026 •

edited

Loading

github-actions Bot commented Oct 9, 2026 •

edited

Loading

chatgpt-codex-connector Bot commented Oct 9, 2026 •

edited

Loading