Skip to main content
Glama

get_story_journal

Retrieve a story's checkpoint journal with secret values masked, returning availability and entries or a 404 for unknown plan/story keys.

Instructions

Return the story's checkpoint journal with secret values masked.

Returns {"available": bool, "entries": [...]}; a story that has not checkpointed is {"available": False, "entries": []}. An unknown plan/story returns {"ok": False, "status": 404, "error": ...}.

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": {
      "plan_name": "<plan_name>",
      "story_key": "<story_key>"
    },
    "name": "get_story_journal"
  }
}

Input Schema

NameRequiredDescriptionDefault
plan_nameYes
story_keyYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.10.0

TDQS

B3.2/5.0
Behavior4/5

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

With no annotations supplied, the description carries the full behavioral burden and does substantial work: it discloses secret masking, the exact success envelope, the empty-state envelope for a story that never checkpointed, and 404 error semantics for an unknown plan/story. It leaves out read-only framing and any size/pagination or auth notes, but covers far more than a minimal restatement.

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 short sentences, front-loaded with the action and the masking caveat, with no filler wording. The only inefficiency is that the return-shape detail duplicates what the existing output schema already provides.

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

Completeness3/5

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

Return values and error paths are well covered and an output schema exists, so the response side is adequate. The request side is the gap: with 0% schema coverage on both required parameters, an agent gets no help forming a valid plan_name/story_key call, which is a meaningful omission for a two-required-param tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate for two undocumented required parameters — and it does not. Plan_name and story_key get no explanation of format, where they come from, or their relationship, beyond an incidental mention that an 'unknown plan/story' yields a 404.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: 'Return the story's checkpoint journal' with a notable qualifier ('secret values masked'). It is clear what the tool fetches, but it never distinguishes itself from adjacent readers such as get_story_log, get_story_events, or get_story_diff, so the agent must infer which 'story history' surface to pick.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use guidance at all — no condition selecting this over get_story_log or get_story_events, and no stated prerequisites such as needing a prior checkpoint. The only situational information is a post-hoc note about what a non-checkpointed story returns, which describes output rather than instructing the caller.

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