Skip to main content
Glama

Anole AI Visibility

Publish document

publish_document
DestructiveIdempotent

Publishes a document: makes its .md URL public, adds it to the site llms.txt and pushes it to the customer server when auto-deploy is configured.

Input Schema

NameRequiredDescriptionDefault
langNoLanguage code, e.g. en, pl. Defaults to the site language.
siteNoSite domain, e.g. example.com (see list_sites). Optional when the account has one site.
slugYesDocument slug (see list_documents)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=true and openWorldHint=true, so the bar is lower, but the description still earns credit by disclosing the concrete downstream effects — the public URL, the llms.txt entry, and the external push to the customer server. The one gap is that destructiveHint is never explained: nothing warns that republishing can overwrite live/deployed content, and the 'when auto-deploy is configured' condition is mentioned but not elaborated.

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 colon-led sentence that front-loads the action and then lists side effects in order of increasing scope (URL → llms.txt → customer server). No filler, no repetition of the title.

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 three-parameter mutation with no output schema, the description covers the important behavioral surface. It stops short of the one thing an agent would still want to know — what happens on conflict or whether the response reports deploy status — but annotations and schema carry most of the remaining load.

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% — slug, site and lang are all documented in the schema, including defaults and pointer tools like list_sites and list_documents. The description contributes no additional 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?

The definition names a specific verb (publishes) and resource (a document) and then enumerates the three concrete effects: making the .md URL public, adding it to the site's llms.txt, and pushing to the customer server. An agent can tell exactly what state change results, and the inverse sibling (unpublish_document) is unambiguous by name.

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 the description rather than stated: the agent can infer this is the counterpart to unpublish_document and follows create_document/update_document. There is no explicit 'use when…' framing, no prerequisite call (e.g. needing a slug from list_documents — that hint lives only in the schema), and no exclusion conditions.

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.