Skip to main content
Glama

Coda Unpublish Doc

coda_unpublish_doc
Destructive

Unpublish a Coda doc to remove public access and make it private again. The public URL stops working, and you can republish later.

Instructions

Unpublish a Coda doc, removing public access. Returns confirmation with doc_id.

Reverts a previously published doc to private. The public URL will stop working. This is reversible — you can publish again with coda_publish_doc.

Input Schema

NameRequiredDescriptionDefault
doc_idYesThe doc ID to unpublish

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.12.1
    • changedOutput schema / (root)
      Previous value: -{
      -  "properties": {
      -    "result": {
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "result"
      -  ],
      -  "type": "object",
      -  "x-fastmcp-wrap-result": true
      -}New value: +null
  2. First observedv0.4.14

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already flag this as a non-read-only, destructive, open-world mutation, and the description usefully adds what actually happens (the public URL stops working), that it is reversible, and that it returns a confirmation with doc_id. The reversibility note materially refines the impact beyond the bare destructiveHint, though it doesn't cover permissions or side effects on existing viewers.

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?

Front-loads the core action and effect in the first sentence, then adds impact and reversibility. Slightly redundant between 'removing public access' and 'the public URL will stop working,' but each sentence otherwise earns its place.

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?

With no output schema, the description steps in to describe the return (confirmation with doc_id), states the effect on the public URL, and notes reversibility. It is complete enough to call correctly, missing only permission/auth prerequisites that the annotations do not supply.

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 coverage is 100% for the single doc_id parameter, so the schema already carries the semantics. The description only references doc_id in the return value and adds no format or constraint detail beyond the schema; 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?

States a specific verb (unpublish) and resource (Coda doc) with the concrete effect (removing public access). It is cleanly distinguishable from its obvious sibling coda_publish_doc, which it names directly.

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

Usage Guidelines4/5

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

Clearly frames the use case — reverting a previously published doc to private — and names the alternative (coda_publish_doc) for the reverse operation. It stops short of an explicit when-not or a prerequisite/permission statement, so it is strong but not fully prescriptive.

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