Skip to main content
Glama
hybriden

Paperboy CMS

Official
by hybriden
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

delivery_get_by_path

Read-only

Check what a live URL shows by fetching the published page at a path. Returns public delivery data with SEO metadata, or null if not found.

Instructions

Read the page a visitor gets at a URL path — the way to check what a live URL shows. Returns the item as the public Delivery API serves it — published only (unless preview), private fields removed, plus computed urlPath, fieldTypes and SEO metadata on pages — or null when nothing matches. Use get_content to read a draft for editing.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesThe page's URL path without the locale prefix, e.g. '/blog/my-post'.
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.
localeNoLocale code. Omit for the document's own locale (its site-default variant, else its only variant).
previewNotrue = read the latest drafts as the preview pane shows them (needs site-wide read access). Default false: published content only, exactly what visitors get.
populateNoHow many levels of references and shared blocks to resolve inline, 0-4 (default 0: references stay as ids).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.1.3
    • addedInput schema / properties / path / description
      Added value: +"The page's URL path without the locale prefix, e.g. '/blog/my-post'."
    • addedInput schema / properties / populate / description
      Added value: +"How many levels of references and shared blocks to resolve inline, 0-4 (default 0: references stay as ids)."
    • changedInput schema / properties / preview / description
      Previous value: -"Use the preview perspective (drafts)"New value: +"true = read the latest drafts as the preview pane shows them (needs site-wide read access). Default false: published content only, exactly what visitors get."
  2. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds real behavioral context beyond that: published-only unless preview, private fields stripped, and a null return when nothing matches. It could say more about preview access requirements (the schema carries that) but this is well above the annotation baseline.

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?

Three front-loaded sentences: the purpose first, then return semantics, then the routing alternative. No filler, and the most decision-relevant fact (what the live URL returns) leads.

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?

No output schema exists, so the description carries the return burden and does so: it explains the item shape (public fields, computed urlPath/fieldTypes/SEO metadata) and the null case. Nothing an agent needs to call this correctly is missing.

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 coverage is 100%, so all five parameters are already documented in the schema, including preview and populate semantics. The description only echoes 'unless preview' and adds no syntax or defaults beyond what the schema provides, 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?

States a specific verb (read) and resource (the page a visitor gets at a URL path) and frames the exact use case ('check what a live URL shows'). It clearly differentiates itself from get_content (drafts) and, by implication, the other delivery_* readers.

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

Usage Guidelines5/5

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

Names the alternative explicitly ('Use get_content to read a draft for editing') and states the condition that selects this tool ('the way to check what a live URL shows'). The published-vs-draft boundary is the deciding factor and it is spelled out.

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