publish_site
Publish the saved revision to a public hosted address. Requires sites:publish.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | No | ||
| revision | Yes | ||
| idempotencyKey | Yes | Unique random key for this operation; reuse exactly when retrying |
Publish the saved revision to a public hosted address. Requires sites:publish.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | No | ||
| revision | Yes | ||
| idempotencyKey | Yes | Unique random key for this operation; reuse exactly when retrying |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare idempotentHint=true, destructiveHint=false and openWorldHint=true, so the description is not carrying the safety burden alone. It still adds real context beyond them: the auth scope required and the fact that the effect is making content publicly reachable at a hosted address — a consequential, externally visible side effect. It omits what happens to a previously published revision or how conflicts are handled.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the action and outcome, with the auth requirement trailing as a precondition. Nothing is wasted, though a single extra clause on `slug` would have cost little.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
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 should say something about the resulting published address, which it only alludes to. Annotations cover the mutation/idempotency profile, but a publish operation that exposes content publicly leaves the agent guessing about the optional slug and the revision contract.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 33%: only idempotencyKey is documented in the schema. The description hints that `revision` refers to an already-saved revision, but never explains the `slug` parameter (the published address identifier) even though the phrase 'public hosted address' gestures at it. With low schema coverage, the description should compensate and does not.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Publish the saved revision') plus the observable outcome ('to a public hosted address'), which is enough to tell it apart from save_site and preview_site. It stops short of explicitly naming the sibling it replaces or the sibling that reverses it (unpublish_site).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The required scope (sites:publish) is a useful gating condition, and 'the saved revision' implies the site must already be saved. However, there is no explicit guidance on when to publish vs. preview_site or when to check publication_status, and no mention that unpublish_site is the inverse.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.