Skip to main content
Glama

journal-update

Rename a journal entry or move it to another folder (metadata only; pages are edited with journal-page-update). folder takes a folder ID; a unique folder NAME is resolved to its ID. addCategories / updateCategories manage its page categories (bridge module 8.19.0+, Foundry 13+); a page joins one through journal-page-update categoryId.

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": {
      "journalId": "<journalId>"
    },
    "name": "journal-update"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoNew name for the journal
folderNoTarget folder ID (from folder-list with type "JournalEntry"); a unique folder name is also accepted.
journalIdYesThe journal ID to update
addCategoriesNoCategories to create: [{name, sort?}]
updateCategoriesNoCategory changes: [{categoryId (from journal-get), name?, sort?}]

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / addCategories
      Added value: +{
      +  "description": "Categories to create: [{name, sort?}]",
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "name": {
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "sort": {
      +        "type": "integer"
      +      }
      +    },
      +    "required": [
      +      "name"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / updateCategories
      Added value: +{
      +  "description": "Category changes: [{categoryId (from journal-get), name?, sort?}]",
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "categoryId": {
      +        "type": "string"
      +      },
      +      "name": {
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "sort": {
      +        "type": "integer"
      +      }
      +    },
      +    "required": [
      +      "categoryId"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, and idempotentHint=false; the description adds real context beyond them — the operation is metadata-only and does not touch page content, and category parameters are gated on bridge module 8.19.0+ / Foundry 13+. It does not explain what happens to unspecified fields or the non-idempotent nature of repeated calls, which keeps it off a 5.

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 scope constraint and the sibling hand-off are front-loaded in the first clause, and every sentence carries information. The dense semicolon-chained phrasing makes it slightly harder to scan than an ideal definition, but nothing is wasteful.

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 a five-parameter mutation with no output schema, the definition covers scope, folder resolution, category semantics, and version gating. It leaves open what happens when only the required journalId is supplied (no name/folder/categories), and how an ambiguous folder name is handled — minor gaps for a metadata update.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds meaning beyond the schema: `addCategories`/`updateCategories` operate on *page* categories rather than entry metadata, and pages join a category via journal-page-update's categoryId. The folder name-resolution rule largely repeats the schema text, which caps the score.

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 specific verb and resource ("Rename a journal entry or move it to another folder") plus an explicit scope boundary ("metadata only"). It names the sibling that handles the excluded work (journal-page-update), so an agent can distinguish the two without opening either schema.

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 routing: page content goes to journal-page-update, and page-category joins go through journal-page-update's categoryId. It also states that `folder` accepts an ID or a unique name. It stops short of explicit exclusions (e.g. use journal-delete to remove, or what to do for non-unique folder names), so not a full 5.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources