Write in a batch's journal
journal_noteUse this when the user wants to add a dated line to a batch's maceration journal, or correct one.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | No | ||
| text | Yes | ||
| batch | No | ||
| noteId | No |
journal_noteUse this when the user wants to add a dated line to a batch's maceration journal, or correct one.
| Name | Required | Description | Default |
|---|---|---|---|
| date | No | ||
| text | Yes | ||
| batch | No | ||
| noteId | No |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly=false, idempotent=false and destructive=false, so the mutation profile is covered structurally. The description adds that entries can be corrected, hinting at overwriting an existing note while claiming non-destructiveness, but it never states whether correction replaces or appends, nor any permission requirement.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence that states the use case before the fallback mode, with no filler. It is arguably under-specified rather than over-verbose, but structurally it is clean.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a non-idempotent write tool with four undocumented parameters and no output schema, the description omits essentials: how the batch is identified, what 'correct' does to the prior text, whether date is free-form, and what is returned. An agent can guess the happy path but not the edit path.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With 0% schema description coverage across 4 parameters, the description carries the full explanatory burden and largely fails it. 'Dated line' loosely implies the date parameter and 'correct one' hints at noteId, but text and batch (the required and scope-defining parameters) are never explained, and no formats or constraints are given.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description gives a concrete verb+resource: adding a dated line to a batch's maceration journal, with a secondary mode of correcting an existing entry. It is clearly differentiable in kind from generic siblings, but it never names or contrasts with write_note or log_batch, which an agent must disambiguate among.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It supplies a when-to-use trigger ('when the user wants to add a dated line... or correct one'), which is real guidance. However, it offers no when-not and no alternatives, leaving the journal_note vs write_note vs log_batch routing decision entirely to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.