Skip to main content
Glama

Update report page

update_page

Update a page — only include the fields you want to change

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoPage name
page_idYesPage ID (from list_pages)
visibleNoShow or hide the page
positionNoReorder the page to this position

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoThe page as saved — page_id, name, position and visible.
successYesTrue when the call succeeded. A failure comes back as an error result instead.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "data": {
      +      "additionalProperties": {},
      +      "description": "The page as saved — page_id, name, position and visible.",
      +      "type": "object"
      +    },
      +    "success": {
      +      "description": "True when the call succeeded. A failure comes back as an error result instead.",
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "success"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already indicate a write operation (readOnlyHint=false) and non-destructive nature (destructiveHint=false). The description adds the key behavior that only specified fields are updated ('only include the fields you want to change'), which is a meaningful behavioral trait not captured in the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, compact sentence that immediately states the action and the key usage rule. Every word earns its place, with no fluff or repetition.

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 simple update tool with four parameters (one required) and full schema coverage plus an output schema, the description covers the essential behavioral note. It does not mention error cases or return details, but those are reasonably handled by the schema and output schema, so the description is adequate.

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% and each parameter has a description. The tool description adds the crucial semantic that parameters are optional and only included fields get changed, which is not conveyed by the individual parameter descriptions. This enriches understanding of how to use the parameters correctly.

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 clearly states the action ('Update a page') with a specific resource. It is unambiguous and distinct from sibling tools like create_page, delete_page, and list_pages. The additional note about partial updates further clarifies the tool's role.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage (updating an existing page) but does not explicitly contrast with alternatives or state prerequisites (e.g., page must exist, page_id from list_pages). While the schema mentions page_id from list_pages, the description itself offers no guidance on when to choose this tool over others.

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