Skip to main content
Glama

journal_write

Record one project event as a timestamped daily journal entry, a decision note, or an intent pivot in the Knowledge Base for later distillation.

Instructions

Write one event to the current project's journal. kind: 'append' = timestamped entry in today's daily journal file in the Knowledge Base (creates the file if it doesn't exist; both calls on the same calendar day return the same file_id; returns {file_id}). kind: 'note' = free-form decision/abandonment/observation, stored as an agent_note event in Layer 1 (surfaces in distilled task entries; returns {ok, recorded_at}). kind: 'intent' = topic/intent pivot, use when the user redirects what you're working on so the distillation step splits task buckets correctly (returns {ok, recorded_at}). Required fields depend on kind: 'append'/'note' need text; 'intent' needs summary.

Input Schema

NameRequiredDescriptionDefault
kindYesEvent kind. Selects which body fields are required and how the event is stored.
tagsNoOptional for kind='note'. Tags for the note.
textNoRequired for kind='append' or kind='note'. Body of the entry.
summaryNoRequired for kind='intent'. One-line summary of the new intent.
project_idNoOptional for kind='append'. Project ID context.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv6.1.2

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses file auto-creation, that same-day appends return the same file_id, the storage layer for notes (Layer 1 agent_note events), and the return shapes for each mode. It omits auth/permission requirements and error behavior.

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?

Front-loaded purpose followed by kind-by-kind breakdown, with return values parenthesized inline so the agent can scan quickly. It is dense and fairly long, but nearly every clause carries useful information rather than filler.

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?

There is no output schema, so the description correctly supplies return shapes per mode, and with no annotations it also covers storage semantics and file behavior. This is sufficient for an agent to invoke the tool correctly.

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?

Schema description coverage is 100%, so the baseline is 3; the schema already documents each field's per-kind requirement. The description restates the kind-to-required-field map and adds what each kind semantically means, but adds little about parameter syntax or formats beyond the schema.

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 concrete verb and resource ('Write one event to the current project's journal') and then enumerates the three distinct modes with what each one does and stores. This clearly separates it from sibling journal tools like journal_distill, journal_status, and journal_housekeep.

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 mode-specific selection guidance, notably the explicit 'use when the user redirects what you're working on' condition for kind='intent'. It does not, however, state when not to use this tool or name alternative siblings for capturing information.

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