Skip to main content
Glama

Update page

update_page

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": {
      "page_id": "<page_id>"
    },
    "name": "update_page"
  }
}

Input Schema

NameRequiredDescriptionDefault
codeNoThe page's whole new code. Omit to keep the code as it is.
nameNoNew name.
page_idYesThe page's id (list_pages).
archivedNoTrue archives the page (it leaves the Pages list but is kept); false unarchives it. An archived page changes only in a call that also unarchives it.
change_noteNoWhat changed, shown in the page's history, e.g. "Added a Next step column".
descriptionNoNew one-line description.
on_behalf_ofNoA teammate's email, or an agency client's from list_agency_clients, to run this call in that account: their agents, settings, connected accounts, and credits. Omit it to act on your own account.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / on_behalf_of / description
      Previous value: -"An agency client's email, from list_agency_clients, to run this call in that client's account: their agents, settings, connected accounts, and credits. Omit it to act on your own account."New value: +"A teammate's email, or an agency client's from list_agency_clients, to run this call in that account: their agents, settings, connected accounts, and credits. Omit it to act on your own account."
  2. Added

TDQS

A4.4/5.0
Behavior4/5

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

Annotations only say readOnlyHint=false and destructiveHint=false; the description adds the crucial behavior that new code replaces the whole page and that changes are visible to every teammate on their next open. The version-on-write behavior explains why the operation is not counted as destructive, so there is no annotation contradiction. It stops short of stating permission requirements or what happens to concurrent edits, but it materially exceeds the annotation content.

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 summary is front-loaded with the operation list, then the code-replacement caveat, then visibility, and it wraps a clear returns note. Every sentence carries information, with only minor redundancy between 'replaces the whole page' and 'send it back complete'.

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?

For a 7-parameter mutation on a shared collaborative object, the definition covers the destructive-adjacent code overwrite, the required read-first workflow, team visibility, and the return value (the list_pages row). Nothing an agent needs to call this safely is missing, and the detailed schema covers the remaining per-field semantics.

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 workflow-level meaning to the code parameter beyond the schema's 'whole new code': the agent must fetch and resend the complete page. The archive/unarchive semantics and change_note behavior are left entirely to the schema, which is acceptable given its detail.

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?

The description names a specific verb and resource and enumerates the concrete mutations it performs: saving new code as the next version, renaming, redescribing, archiving and unarchiving. It also distinguishes itself from many siblings by pointing at get_page as the prerequisite read, so an agent can place it among update_*, create_page and restore_page_version without opening the 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?

It gives an explicit precondition-and-procedure for the risky case: read the live code with get_page first and send it back complete, which implies metadata-only edits (name/description/archive) can be done without that read. It does not name alternatives for rollback (restore_page_version) or for creating a page (create_page), so usage is clear but not fully routed.

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