Skip to main content
Glama

journal-page-update

Update a journal page. content REPLACES the whole page text (no append): read it with journal-page-get, edit, and send the full HTML back. Same HTML rules as journal-page-create.

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>",
      "pageId": "<pageId>"
    },
    "name": "journal-page-update"
  }
}

Input Schema

NameRequiredDescriptionDefault
srcNoNew source file path or URL for image/video/pdf pages
nameNoNew name for the page
pageIdYesThe page ID to update
contentNoNew HTML content for text pages
journalIdYesThe journal ID containing the page
categoryIdNoMove to this page category; null = none (bridge module 8.19.0+, Foundry 13+)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / categoryId
      Added value: +{
      +  "description": "Move to this page category; null = none (bridge module 8.19.0+, Foundry 13+)",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
  2. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations only say readOnlyHint=false, destructiveHint=false, idempotentHint=false; they do not convey that the write is a wholesale replacement. The description adds exactly that warning ("content REPLACES the whole page text (no append)"), which is the single most important behavioral fact for avoiding accidental data loss. It also inherits formatting rules by reference to journal-page-create, giving useful context without repeating it. It does not address errors, permissions, or whether partial field updates are atomic.

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 destructive-replacement caveat and followed by the corrective workflow. There is no filler. The cross-reference to journal-page-create is compact but requires the agent to open a second definition to learn the HTML rules.

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 mutation tool with no output schema, the description covers the operation, the required read-modify-write sequence, and the payload format contract, which are the essentials. Field-level details for src, name, and categoryId are fully covered by the schema, so their absence from the description is acceptable. Missing are return/response expectations and error behavior, which keep it below 5.

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 all six parameters including content, src, and categoryId are already documented in the schema, establishing a baseline of 3. The description adds genuine meaning for content (whole-page replacement, HTML payload, round-trip through journal-page-get) beyond the schema's "New HTML content for text pages", which is a modest lift over baseline rather than a full elaboration.

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?

"Update a journal page" gives a specific verb and resource, and the following sentences immediately narrow the meaning of the operation to a full-content overwrite rather than a patch. Sibling alternatives (journal-page-create, journal-page-get) are named, so an agent can route between the read, create, and update paths. A 5 would require an explicit statement of what this tool does not touch (e.g. name vs content fields).

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?

It prescribes an actual workflow: read with journal-page-get, edit locally, then send the full HTML back. That is concrete when-to-use and how-to-sequence guidance rather than vague context. It stops short of stating exclusions or failure conditions (e.g. what happens on stale content or on pages of other types).

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