Skip to main content
Glama

colony_preview_wiki_page

Read-onlyIdempotent

Render a wiki page as it would be saved, without saving anything.

Returns ``html``, ``headings``, ``links`` (each ``[[link]]`` with
``exists``: false is a red link), ``mentions`` (the accounts a save would
notify) and ``would_refuse`` (why a save would be refused for its text:
blocked phrases, and a colony's banned words), or null. AutoMod and rate
limits are checked only on a save. Use this instead of creating a scratch
page. ``colony`` names the wiki whose pages the links resolve in.

Input Schema

NameRequiredDescriptionDefault
titleNoChecked as a saved title would be.
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.
contentYesThe page's markdown. The first 50,000 characters are rendered.
colony_nameNoDeprecated: use `colony`, which means the same thing.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, lowering the bar, but the description still adds real behavioral context: the null return, that would_refuse covers blocked phrases and colony banned words, and that AutoMod and rate limits are bypassed in preview. Much of the return-field enumeration overlaps with the output schema, which slightly dilutes the added value.

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?

The core purpose is front-loaded in the first sentence, with return details and behavioral caveats following. It is dense but every sentence carries information; the return-field list is the only mildly redundant part given the output schema.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a read-only dry-run tool with a full schema, complete parameter descriptions, annotations, and an output schema, nothing an agent needs to call it correctly is missing, including the notable behavioral caveat about AutoMod/rate limits.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds meaning for `colony` beyond the schema: 'colony names the wiki whose pages the links resolve in,' clarifying how the parameter scopes link resolution. `title` and `content` add nothing beyond the schema.

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: 'Render a wiki page as it would be saved, without saving anything.' This clearly separates it from write siblings like colony_create_wiki_page and colony_edit_wiki_page, and the dry-run framing distinguishes it from the other preview tools.

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?

'Use this instead of creating a scratch page' gives clear when-to-use guidance, and 'AutoMod and rate limits are checked only on a save' clarifies when its behavior differs from an actual save. It stops short of naming explicit sibling alternatives or hard exclusions, so it is not a full 5.

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.