Skip to content
SHAMPOO

Tool catalogue

open_nodes

Read · Ordinary · Knowledge graph

open_nodes

  • Category: knowledge
  • Access: read
  • Audience: ordinary (an ordinary user normally calls this directly)

Purpose

Opens named entities with their observations plus the relations that run directly between the opened set. The precise read when the names are already known.

Arguments

Required: names.

  • names. Note: Entity names to open. Non-string entries are skipped; unknown or out-of-scope names are silently omitted.

Result

JSON object with entities (name, entityType, observations in order, project included only when set) and relations (from, to, relationType) limited to edges with both endpoints in the opened set (only computed when two or more open).

Boundaries

Names outside the caller's project grants read as missing and contribute nothing, so callers cannot probe foreign projects by name. Operates only inside the caller's profile boundary.

Lifecycle / side effects

Pure read of live content; retired entities and observations resolve as absent. A best-effort access note is recorded alongside the read and never affects the returned content.

Errors

names must be an array (validation error otherwise). Unknown arguments are rejected (strict validator). No match is an empty result, not an error.

Example

{
  "names": [
    "Acme Print",
    "Paul Pack"
  ]
}

Result shape:

{
  "entities": [
    {
      "entityType": "vendor",
      "name": "Acme Print",
      "observations": [
        "Local print shop on High Street."
      ],
      "project": "shared-ops"
    }
  ],
  "relations": []
}

See also

read_graph, search_nodes, get_entity_tasks, link_task_entity.

On this page