Skip to main content
Glama

Publish Document

publish_document
DestructiveIdempotent

Change publication and public access settings. Publishing can make content public.

Input Schema

NameRequiredDescriptionDefault
idYes
statusYes
accessScopeNo
listedPubliclyNo
expectedRevisionYes

Output Schema

NameRequiredDescriptionDefault

No arguments

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 declare destructiveHint=true, openWorldHint=true, idempotentHint=true, and readOnlyHint=false. The description adds useful context that publishing can make content public, which is a meaningful risk beyond the annotations, but it does not explain permissions, concurrency behavior, or how unpublishing affects existing public access.

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?

Two short sentences with no wasted words, and the public-exposure warning is appropriately front-loaded after the core purpose. It is concise and readable, though for a destructive five-parameter tool it may be too terse to be fully useful.

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?

The description is incomplete for a destructive, open-world mutation tool with five parameters and 0% schema description coverage. Even though an output schema exists, the description omits required parameters, enum meanings, concurrency requirements, and the practical effects of changing publication settings.

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% for all five parameters, so the description must compensate and it largely does not. It vaguely gestures at publication status and access scope but never mentions required parameters like id and expectedRevision, nor explains the DRAFT/PUBLISHED enum or the listedPublicly flag.

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 states a clear verb and resource: change publication and public access settings. It is specific enough to distinguish the tool's domain from generic document updates, but it does not explicitly differentiate it from siblings like update_document or archive_document.

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?

The description gives no explicit guidance on when to use this tool versus alternatives. The sentence 'Publishing can make content public' is a consequence warning, not usage guidance, and there is no mention of prerequisites or when not to use it.

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