Skip to main content
Glama
LiLara-AI

ShadowGraph

Official

shadowgraph_journal

Read-onlyIdempotent

Read the append-only journal of post-operation snapshots in sequence order, with paging and project filtering for immutable audit evidence.

Instructions

Read the append-oriented journal of complete post-operation snapshots, in sequence order. shadowgraph_rebuild replays it into a projection, shadowgraph_validate diagnoses live data, shadowgraph_search finds records. Reads only. Entries are immutable audit evidence and are never rewritten in place.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum items to return, 1-1000; the default is 50 and completeness.limitSource reports which applied. Out of range is rejected, never silently clamped.
offsetNoItems to skip before this window. Ordering is total and deterministic, so paging cannot drop or duplicate an item.
projectNoReturn only entries recorded for this project. Omit for every project, including entries with no project.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageYesThe window actually applied to the matching items.
itemsYesThe items in this window, in deterministic order.
completenessYesDeclares exactly what this response left out, so a truncated result can never look complete.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed4 schema fields changedv0.40.1
    • changedInput schema / properties / limit / description
      Previous value: -"Page size. Omitted means a declared default, never silent truncation."New value: +"Maximum items to return, 1-1000; the default is 50 and completeness.limitSource reports which applied. Out of range is rejected, never silently clamped."
    • changedInput schema / properties / offset / description
      Previous value: -"Page offset."New value: +"Items to skip before this window. Ordering is total and deterministic, so paging cannot drop or duplicate an item."
    • addedInput schema / properties / project / description
      Added value: +"Return only entries recorded for this project. Omit for every project, including entries with no project."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "description": "Journal entries with pagination, replay boundary, and declared gaps.",
      +  "properties": {
      +    "completeness": {
      +      "description": "Declares exactly what this response left out, so a truncated result can never look complete.",
      +      "properties": {
      +        "complete": {
      +          "description": "True only when every matching item is present.",
      +          "type": "boolean"
      +        },
      +        "gaps": {
      +          "description": "Sequence ranges missing from the journal, each { from, to }. A hard purge legitimately creates one; it is declared, not hidden.",
      +          "items": {
      +            "properties": {
      +              "from": {
      +                "description": "First missing sequence.",
      +                "type": "integer"
      +              },
      +              "to": {
      +                "description": "Last missing sequence.",
      +                "type": "integer"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "journalEpoch": {
      +          "anyOf": [
      +            {
      +              "type": "integer"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ],
      +          "description": "First replayable sequence, or null when nothing is replayable."
      +        },
      +        "journalSeq": {
      +          "description": "Highest sequence issued so far.",
      +          "type": "integer"
      +        },
      +        "limitSource": {
      +          "description": "Whose choice bounded the result.",
      +          "enum": [
      +            "caller",
      +            "default"
      +          ],
      +          "type": "string"
      +        },
      +        "losslessItems": {
      +          "description": "Always true: each returned item is a full-fidelity record, never a summary or a truncated field.",
      +          "type": "boolean"
      +        },
      +        "omitted": {
      +          "description": "total minus returned.",
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        "returned": {
      +          "description": "Items in this response.",
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        "scope": {
      +          "description": "The project, query, and structured filters that produced this result, so it explains its own derivation.",
      +          "type": "object"
      +        },
      +        "total": {
      +          "description": "Items that matched in total.",
      +          "minimum": 0,
      +          "type": "integer"
      +        }
      +      },
      +      "required": [
      +        "scope",
      +        "returned",
      +        "total",
      +        "complete",
      +        "omitted",
      +        "losslessItems",
      +        "limitSource",
      +        "journalEpoch",
      +        "journalSeq",
      +        "gaps"
      +      ],
      +      "type": "object"
      +    },
      +    "items": {
      +      "description": "The items in this window, in deterministic order.",
      +      "items": {
      +        "description": "One journal entry: a complete post-operation snapshot. Entries imported from older schemas may lack seq or payload.",
      +        "properties": {
      +          "at": {
      +            "description": "ISO 8601 time the entry was appended.",
      +            "type": "string"
      +          },
      +          "causationId": {
      +            "description": "Present only when this entry was caused by another; carries that entry id.",
      +            "type": "string"
      +          },
      +          "entityId": {
      +            "anyOf": [
      +              {
      +                "type": "string"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ],
      +            "description": "Identifier of that entity; null on a redacted skeleton."
      +          },
      +          "entityKind": {
      +            "anyOf": [
      +              {
      +                "type": "string"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ],
      +            "description": "Kind of the entity the entry is about."
      +          },
      +          "id": {
      +            "description": "Entry identifier.",
      +            "type": "string"
      +          },
      +          "idempotencyKey": {
      +            "description": "Present only when the write carried a retry key.",
      +            "type": "string"
      +          },
      +          "payload": {
      +            "anyOf": [
      +              {
      +                "type": "object"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ],
      +            "description": "The complete post-operation snapshot, or null once a logical purge reduced the entry to an audit skeleton."
      +          },
      +          "project": {
      +            "anyOf": [
      +              {
      +                "type": "string"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ],
      +            "description": "Project the entry belongs to."
      +          },
      +          "provenance": {
      +            "description": "actor, client, and sessionId recorded with the write; all null on purged skeletons.",
      +            "type": "object"
      +          },
      +          "redacted": {
      +            "description": "Present only on entries reduced by a logical purge.",
      +            "type": "boolean"
      +          },
      +          "redactedReason": {
      +            "description": "Why the entry was reduced.",
      +            "type": "string"
      +          },
      +          "schemaVersion": {
      +            "description": "Schema version the entry was written under.",
      +            "type": "integer"
      +          },
      +          "seq": {
      +            "description": "Monotonic sequence number. Absent on pre-journal metadata entries.",
      +            "type": "integer"
      +          },
      +          "transition": {
      +            "description": "Present only on lifecycle changes; carries from, to, and the actor that made them.",
      +            "type": "object"
      +          },
      +          "type": {
      +            "description": "Entry type, such as decision.recorded, fact.observed, memory.superseded, or project.purged.",
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "page": {
      +      "description": "The window actually applied to the matching items.",
      +      "properties": {
      +        "hasMore": {
      +          "description": "True when matching items exist beyond this window.",
      +          "type": "boolean"
      +        },
      +        "limit": {
      +          "description": "Window size applied, whether the caller set it or the default did.",
      +          "minimum": 1,
      +          "type": "integer"
      +        },
      +        "offset": {
      +          "description": "Index of the first item returned.",
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        "total": {
      +          "description": "Matching items before the window was applied.",
      +          "minimum": 0,
      +          "type": "integer"
      +        }
      +      },
      +      "required": [
      +        "offset",
      +        "limit",
      +        "total",
      +        "hasMore"
      +      ],
      +      "type": "object"
      +    }
      +  },
      +  "required": [
      +    "items",
      +    "page",
      +    "completeness"
      +  ],
      +  "type": "object"
      +}
  2. First observedv0.40.0

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, and non-destructive behavior; the description adds that entries are immutable audit evidence, append-only/never rewritten in place, and are complete post-operation snapshots in sequence. This gives the agent meaningful invariants beyond the safety flags.

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?

Three sentences, each with a distinct job: define the resource, route to alternatives, and state immutability/read-only guarantee. Minor redundancy in 'Reads only' given the readOnly annotation, but no waste.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given a full input schema, an output schema, and annotations, the description covers what the journal is, how it is ordered, its read-only/immutable nature, and how it relates to the main sibling tools. An agent has everything needed to select and call it.

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?

All three parameters are fully documented in the schema, including defaults, bounds, and ordering guarantees, so the description does not need to add parameter-level detail and does not do so. Baseline 3 is appropriate.

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?

The description opens with a specific verb ('Read') and resource ('append-oriented journal of complete post-operation snapshots'), and states the sequence ordering. It also distinguishes the tool from three siblings by assigning them distinct jobs (rebuild, validate, search).

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?

It names shadowgraph_rebuild, shadowgraph_validate, and shadowgraph_search with their distinct purposes, which lets an agent infer when journal is the raw-source read rather than those specialized operations. However, the guidance is implicit—it never says 'use X instead' or lists when not to use journal, so it falls just short of fully explicit routing.

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

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/LiLara-AI/shadowgraph'

If you have feedback or need assistance with the MCP directory API, please join our Discord server