Skip to main content
Glama

update_redirect

Idempotent

Modify an existing redirect rule by ID in Paperboy CMS, updating source, target, status, or note while leaving omitted fields unchanged.

Instructions

Update a redirect rule by id (from list_redirects). Same fields and rules as create_redirect; omitted fields are unchanged.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe rule's id from list_redirects.
noteNoFree-text note for editors, e.g. 'old WordPress URL'.
siteNoSite slug or id to act in (multisite). Omit to use this server's default site. Call list_sites to see what exists — an empty tree or search usually means the wrong site, not missing content.
sourceNoOld path ('/old-page'), prefix ('/blog/*') or full URL on the old site.
statusNo301 permanent (default), 302/307 temporary, 308 permanent, 410 gone (no target).
targetNoDestination path or https:// URL. Use this OR targetDocumentId.
keepQueryNoCarry the request's query string over to the target.
targetLocaleNoLocale of targetDocumentId to send visitors to. Omit for the site default.
targetDocumentIdNodocumentId of the destination page; the rule follows it if it moves. Use this OR target.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv0.1.3
    • addedInput schema / properties / id / description
      Added value: +"The rule's id from list_redirects."
    • addedInput schema / properties / keepQuery / description
      Added value: +"Carry the request's query string over to the target."
    • addedInput schema / properties / note / description
      Added value: +"Free-text note for editors, e.g. 'old WordPress URL'."
    • addedInput schema / properties / source / description
      Added value: +"Old path ('/old-page'), prefix ('/blog/*') or full URL on the old site."
    • addedInput schema / properties / status / description
      Added value: +"301 permanent (default), 302/307 temporary, 308 permanent, 410 gone (no target)."
    • addedInput schema / properties / target / description
      Added value: +"Destination path or https:// URL. Use this OR targetDocumentId."
    • addedInput schema / properties / targetDocumentId / description
      Added value: +"documentId of the destination page; the rule follows it if it moves. Use this OR target."
    • addedInput schema / properties / targetLocale / description
      Added value: +"Locale of targetDocumentId to send visitors to. Omit for the site default."
  2. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint=false, destructiveHint=false, idempotentHint=true), so the bar is lower. The description nonetheless adds genuine behavioral context beyond them: omitted fields are left unchanged (PATCH semantics), and it delegates field rules to create_redirect, which is useful for predicting effects.

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?

A single dense sentence with zero filler; the verb-resource-id core is front-loaded, followed by the partial-update rule. Every clause carries information an agent needs.

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 plus rich annotations and a fully documented schema cover what an agent needs to invoke it correctly, including id provenance and partial-update semantics. It does not mention failure behavior (e.g., unknown id) or permission requirements, a minor remaining gap.

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% across all 9 parameters, including enum-like status codes, site, target vs targetDocumentId, and id provenance, so the schema does the heavy lifting. The description adds only a cross-reference to create_redirect rather than new per-parameter meaning, so the baseline 3 applies.

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?

Specific verb (update) plus resource (redirect rule) plus the locating constraint (by id from list_redirects), which tells the agent exactly which identifier to supply. It also routes the agent to two named siblings — list_redirects for the id and create_redirect for field semantics — so it is distinguishable from neighboring redirect tools without opening schemas.

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?

The description establishes the operating context (modify an existing rule, fields and rules inherited from create_redirect) and the partial-update contract ('omitted fields are unchanged'), which steers the agent on how to call it. It stops short of an explicit when-not or a direct contrast such as 'use create_redirect to add a new rule instead'.

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