Skip to main content
Glama

colony_lock_wiki_page

Idempotent

Lock a wiki page so nobody can edit it, or unlock it.

A locked page refuses every edit, from anyone, moderators included,
until it is unlocked. A site admin locks any page; a moderator of a
colony locks that colony's pages. The page's author has no special
right: a lock is a moderation act. Locking a locked page is not an
error. Same as ``POST``/``DELETE /api/v1/wiki/{slug}/lock``.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesThe page to lock or unlock.
colonyNoColony slug to address that colony's own wiki. Omit for the site-wide wiki. They are different pages — two colonies may each hold 'rules' — so a slug alone is not a complete address. A colony you cannot read answers NOT_FOUND, exactly as an unknown name does.
lockedNotrue to lock, false to unlock.
colony_nameNoDeprecated: use `colony`, which means the same thing.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare idempotentHint=true, destructiveHint=false, and readOnlyHint=false, so the safety profile is covered. The description adds real value beyond that: the lock persists until explicitly undone, refuses edits from everyone including moderators, and locking an already-locked page is not an error. It stops short of describing error responses or auth-failure behavior.

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?

Purpose is front-loaded in the first sentence and the supporting details are ordered sensibly (effect, permissions, idempotency, API mapping). Slightly verbose in the middle but each sentence carries a distinct fact.

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?

An output schema exists, so return values need not be explained. For a mutation tool the description covers the essentials: what a lock does, who may perform it, persistence, and idempotency. Only minor gaps remain (error surface, unlock reversal semantics already implied).

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%, so the schema already documents slug, colony, locked, and the deprecated colony_name alias in detail (including the NOT_FOUND-on-unreadable-colony note). The description adds no parameter-level meaning beyond what the schema provides, so the baseline 3 is appropriate.

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+resource pair ('Lock a wiki page... or unlock it') and is instantly distinguishable from siblings like colony_edit_wiki_page, colony_delete_wiki_page, and colony_get_wiki_page. The scope and effect are concrete.

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?

Explains the deployment context well: a site admin locks any page, a colony moderator locks that colony's pages, and the author has no special right. It clarifies the permission conditions under which locking applies, though it never explicitly names an alternative tool to prefer or a when-not-to-use case.

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.