Skip to main content
Glama

Journal entry

journal_entry

Record a finished work chunk's outcome and summary in the agent journal, with status, next steps, and commit details; same-session audit entries are attached automatically.

Instructions

Write to the agent journal the outcome of a finished chunk of work. summary — 2-4 sentences: what and why. outcome — done/failed/partial/reverted. next — what is left (optional). commit — git hash, if the work produced a commit (optional). refs — arbitrary references (optional). The server itself attaches all audit entries of the SAME session since the previous journal entry of that same session (or since the start of the connection, if there was no entry yet) — there is no need to find and specify the range manually. If you are explicitly continuing an interrupted task from another (older) session, pass continuesFromSeq — seq of the last accounted audit entry, so its tail is not lost.

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": {
      "summary": "<summary>",
      "outcome": "<outcome>"
    },
    "name": "journal_entry"
  }
}

Input Schema

NameRequiredDescriptionDefault
nextNo
noteNoShort human-readable explanation (1 line, in the user's language) of what you are about to do and why. Shown to the user on the approval card. Always provide when calling mutating tools.
refsNo
agentNoShort consistent identifier or display name of this agent (e.g. 'Claude · Лендинг', 'Тесты', 'Мой агент'). Used to separate tasks and route tray messages when multiple agents work in parallel.
commitNo
outcomeYes
summaryYes
continuesFromSeqNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

Goes well beyond the annotations by explaining that the server auto-attaches all same-session audit entries since the previous entry (or connection start), and what continuesFromSeq does to preserve an older session's tail. That is real behavioral context an agent could not derive from readOnlyHint/destructiveHint/idempotentHint. It still says nothing about failure modes, size limits, or what happens if the journal write is rejected.

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?

The purpose sentence comes first, then a compact em-dash-delimited parameter glossary, then the non-obvious session semantics — no filler and no repetition of the schema. It is dense and reads like a checklist, but every sentence carries information the caller needs.

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 an 8-parameter mutation tool with no output schema and thin schema descriptions, the definition covers nearly all parameters plus the server-side audit-attachment behavior, which is the hardest part to guess. Missing only return/error expectations and any note on the approval flow implied by the 'note' parameter.

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

Parameters5/5

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

Schema description coverage is only 25%, so the description must carry the load, and it does: summary, outcome (with its enumerated values), next, commit, refs and continuesFromSeq are each defined in prose, including lengths ('2-4 sentences') and conditional use ('if the work produced a commit', 'optional'). Only 'refs' stays vague ('arbitrary references'), a minor gap against an otherwise complete parameter walkthrough.

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?

States a specific verb and resource ('Write to the agent journal') plus the trigger ('the outcome of a finished chunk of work'), which is far more than the title restated. It does not, however, contrast itself with the similarly named sibling journal_log, so the agent must infer which one records vs. reads.

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?

Gives clear when-to-use context (after a chunk of work is finished) and a specific extra case (continuing an interrupted task from an older session, which requires continuesFromSeq). It even removes a false task ('no need to find and specify the range manually') but never names an alternative tool or states when not to use this one.

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