Skip to main content
Glama

Publish page

publish_page
Idempotent

Publish an exact note, folder or file as a NotePom public page.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugNo
entityIdYes
isIndexedNo
accessModeNo
entityTypeYes
idempotencyKeyYes
isListedOnProfileNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageYes
passwordNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.9/5.0
Behavior3/5

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

The annotations already communicate write semantics, idempotency, non-destructiveness, and open-world behavior, so the description need not re-state those. It adds only the outcome ('public page') and the exact entity scoping, but does not disclose whether an existing page is overwritten or what other side effects occur. This is acceptable given annotation coverage, but not richer than baseline.

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?

The description is a single, front-loaded sentence with no filler or repetition. It is compact, though arguably too sparse to compensate for the schema's missing parameter descriptions.

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

Completeness2/5

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

Despite the output schema, an agent cannot infer key semantics such as what idempotencyKey does, how accessMode maps to password/public behavior, whether publishing is a create-or-update operation, or how this differs from publishing a listing. The description is too thin for a tool with this many parameters and tightly related siblings.

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?

The input schema has 0% description coverage and seven parameters, so the description must carry the explanatory load. It only conveys entityType via 'note, folder or file'; required idempotencyKey, slug, accessMode, isIndexed, and isListedOnProfile are left entirely unexplained, which is a significant gap for a 7-parameter tool.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific action ('publish') and resource scope ('exact note, folder or file'), and identifies the resulting artifact as a 'NotePom public page.' It does not explicitly contrast with closely related siblings like publish_note_listing or update_public_page, but the resource phrasing is specific enough to avoid gross confusion.

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

Usage Guidelines2/5

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

There is no guidance on when to choose publish_page over sibling tools such as publish_note_listing, update_public_page, or unpublish_page. No prerequisites, exclusions, or lifecycle context are provided, so the agent must infer selection criteria solely from the tool name.

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