Skip to main content
Glama

publish_json

Publish a JSON object, array, or encoded string to BrewPage, then receive a shareable link and owner token for access control.

Instructions

Publish a JSON document to BrewPage (repository default limit 1 MiB). Accepts a JSON object, array, or a JSON-encoded string containing any valid JSON, including scalars/null. Returns its primary share link and owner token.

Input Schema

NameRequiredDescriptionDefault
jsonYesJSON document to publish (object, array, or JSON-encoded string)
tagsNoOptional tags for the document
ttlDaysNoRequested TTL: days as a number, or a string such as '2w', '36h' or '1 month' (default 15 days). The server rounds to whole days and clamps to the allowed range (1-30 by default; owner caps differ), reporting each adjustment in notices; use returned expiresAt.
passwordNoOptional password to protect the document
namespaceNoOptional. Omit to generate an unlisted namespace: anyone with its unpassworded link can read it, but it is excluded from gallery/search. Pass a custom namespace to group unlisted content, or pass `public` ONLY when the user explicitly wants gallery/search eligibility. Password-protected content stays excluded; unlisted, protected or otherwise ineligible native responses carry noindex; eligible public HTML, sites and files may permit indexing.
ownerTokenNoExisting owner token to group this document under the same owner as previous content
deliveryModeNoOptional delivery choice for a fresh publication, independent of password/namespace. Fresh sites and HTML-format pages outside public (including the default unlisted namespace) always use subdomain; an explicit path there still publishes, on subdomain, with a delivery notice. Everything else in any namespace (Markdown, code/text, files, JSON, KV, public HTML) defaults to path (Promotion); public HTML may automatically choose subdomain for browser features. When creation returns an existing publication, it keeps its actual mode and URL.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior3/5

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

With no annotations, the description carries full burden: it usefully discloses the ~1 MiB repository limit and that the call returns a share link plus owner token. It does not mention that a creation can return an existing publication, nor the visibility/indexing implications, leaving those entirely to the parameter schema.

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?

Two compact sentences, front-loaded with the action and resource, then the payload contract, then the return value. No filler or repetition of schema content.

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 7-parameter mutation tool with no annotations and no output schema, the description covers the essential contract: accepted payload forms, size limit, and return values. The gaps (idempotency/duplicate behavior, visibility defaults) are addressed in the unusually detailed parameter schema, so little is missing for correct invocation.

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 baseline is 3, but the description adds real value by saying the payload may be any valid JSON 'including scalars/null' — the schema's anyOf only lists string/object/array, so this clarifies that scalar content is acceptable (via JSON-encoded string). Other params (ttlDays, namespace, deliveryMode) are left to their rich schema descriptions.

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 resource ('Publish a JSON document to BrewPage') and names the destination, which cleanly separates it from the sibling publish_html, publish_file, publish_kv and publish_site tools that publish other resource types. It also states the observable outcome (share link and owner token).

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?

Usage is implied by 'Publish' and the accepted payload forms, but the description never says when to prefer this over siblings such as update_json/republish_site/get_json, nor when-not to use it. The reader must infer that this is for first-time publication of new JSON content.

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