Skip to main content
Glama

Navigation Patch

navigation_patch
Destructive

Patch Data Studio report navigation—page names, icons, visibility, order, and settings—using versioned RFC 6902 operations with dry-run previews, conflict checks, and read-back verification.

Instructions

Patch report navigation: page names, icons, visibility, order and navigation settings.

RFC 6902 paths are relative to report_inspect.navigation. Preserve unknown properties; every existing page must remain represented exactly once. Versioned request and complete read-back; operation_restore reverses changes.

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": {
      "patches": "<patches>",
      "expected_structure_fingerprint": "<expected_structure_fingerprint>"
    },
    "name": "navigation_patch"
  }
}

Input Schema

NameRequiredDescriptionDefault
dry_runNo
patchesYes
report_idNo
expected_structure_fingerprintYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.5

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false and destructiveHint=true, and the description adds real context beyond them: unknown properties are preserved, existing pages must remain represented exactly once, the request is versioned, and a complete read-back is returned. Reversibility via operation_restore is disclosed. It does not describe what happens when a page is removed or how conflicts are surfaced.

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 dense sentences, front-loaded with the resource scope before the path convention and invariants. Every sentence carries information; the style is terse to the point of being slightly compressed but nothing is wasted.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values need not be explained, and the mutation semantics plus reversibility are covered. However, for a destructive patch tool the unexplained required fingerprint parameter and the absence of any sibling routing guidance leave meaningful gaps.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must carry the parameter burden, and it only partially does: it explains the `patches` path semantics (RFC 6902, relative to report_inspect.navigation) but says nothing about the required `expected_structure_fingerprint`, nor about `dry_run` or `report_id`. The most consequential parameter — a required fingerprint that presumably guards concurrent edits — is left entirely opaque.

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 a tightly scoped resource: patching report *navigation* (page names, icons, visibility, order, navigation settings), which cleanly separates it from the sibling patch tools (components_patch, report_patch). The base path 'relative to report_inspect.navigation' pins down exactly which object is being mutated.

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 concrete operating context: paths are RFC 6902 relative to report_inspect.navigation, and operation_restore is named as the way to reverse changes. It also states a hard precondition (every existing page must remain represented exactly once). It stops short of an explicit when-to-use-this-instead-of-report_patch/components_patch routing statement.

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

Deploy Server

Other Tools