R3

Read an entity template

r3_entity_read

Read-onlyIdempotent

Read one entity template (this account's, or a public one): its current version, the members of the version read (type, name, entityRef; value components such as positions and colours are counted, they belong to their member), the shared code modules it imports, and its recent versions with their notes. version reads an older version, and the references its members hold to components outside the Entity (outsideReferences: infrastructure such as the scene or camera is expected and re-bound on import; anything else is left empty by an import into another project). The current version is the baseVersion r3_entity_save_template needs to update the template.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "templateId": "<templateId>"
    },
    "name": "r3_entity_read"
  }
}

Input Schema

Name	Required	Description	Default
`version`	No	A version to read (default: the current one).
`templateId`	Yes	The template (r3_entity_list shows its templateId).

Output Schema

Name	Required	Description
`name`	Yes
`note`	Yes
`owner`	Yes
`yours`	Yes
`answer`	Yes	This 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.
`imports`	Yes
`members`	Yes
`version`	Yes
`isPublic`	Yes
`versions`	Yes
`templateId`	Yes
`description`	Yes
`readVersion`	Yes
`outsideReferences`	Yes
`valueComponentCount`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedNov 9, 2026

addedOutput schema / properties / outsideReferences

Added value: +{
+  "items": {
+    "additionalProperties": false,
+    "properties": {
+      "expected": {
+        "type": "boolean"
+      },
+      "field": {
+        "type": "string"
+      },
+      "member": {
+        "type": "string"
+      },
+      "memberRef": {
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "targetId": {
+        "type": "string"
+      },
+      "targetType": {
+        "type": [
+          "string",
+          "null"
+        ]
+      }
+    },
+    "required": [
+      "member",
+      "memberRef",
+      "field",
+      "targetId",
+      "targetType",
+      "expected"
+    ],
+    "type": "object"
+  },
+  "type": "array"
+}

changedOutput schema / required

Previous value: -[
-  "templateId",
-  "name",
-  "description",
-  "isPublic",
-  "yours",
-  "owner",
-  "version",
-  "readVersion",
-  "note",
-  "members",
-  "valueComponentCount",
-  "imports",
-  "versions",
-  "answer"
-]New value: +[
+  "templateId",
+  "name",
+  "description",
+  "isPublic",
+  "yours",
+  "owner",
+  "version",
+  "readVersion",
+  "note",
+  "members",
+  "valueComponentCount",
+  "imports",
+  "outsideReferences",
+  "versions",
+  "answer"
+]

AddedNov 6, 2026

TDQS

A4.2/5.0

Behavior4/5

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

Annotations already declare readOnly/idempotent/openWorld, so the bar is lower, yet the description adds real behavioral context: value components are counted rather than returned, and outsideReferences distinguishes infrastructure (re-bound on import) from other references (left empty on import). This is meaningful beyond the annotations, though return format details are left to the output schema.

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

Conciseness3/5

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

The core purpose is front-loaded, but the first sentence is a long, heavily nested run-on that packs members, modules, and versions into one clause chain. It is information-dense but could be broken into shorter sentences for easier parsing.

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 two-parameter read tool with an output schema, the description covers purpose, the version parameter, and the outsideReferences nuance well. It is essentially complete, with only minor reliance on the output schema for exact return shape.

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 100%, so baseline is 3, but the description adds meaning: 'version' reads an older version (default current) and 'templateId' is sourced from r3_entity_list. This goes beyond the schema's own parameter descriptions.

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 ('Read one entity template') and enumerates exactly what is returned: current version, members, imported modules, recent versions. It also scopes ownership ('this account's, or a public one'), which distinguishes it from r3_entity_list and r3_entity_save_template.

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?

Explains that the 'version' parameter reads an older version and that the current version is the baseVersion r3_entity_save_template needs, giving clear context for when to call it. It stops short of explicit when-not-to-use or naming a sibling to prefer, so it is not a full 5.

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

All R3 tools Inspect

Try in Browser

Claude Code, inside the Godot 4 editorFlockbay puts an AI agent in the real Godot 4 editor: it writes GDScript, runs your game and fixes what breaks. Free, or bring your own Claude Code or Codex.flockbay.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?