Skip to main content
Glama

Post a comment

create_comment

Add a markdown comment to a Wiki.js page, or reply to an existing comment, to provide feedback and discussion directly on content.

Instructions

Posts a comment on a page, optionally as a reply to another. The comment is attributed to the account the API key belongs to, which is usually a service account rather than a person — say so in the text if that matters.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
contentYesComment body, in markdown.
page_idYesPage id the comment belongs to.
reply_toNoComment id this replies to.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
truncatedNoPresent only when the answer was shortened to fit the budget.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.3.0
    • changedInput schema / properties / page_id / maximum
      Previous value: -9007199254740991New value: +2147483647
    • changedInput schema / properties / reply_to / maximum
      Previous value: -9007199254740991New value: +2147483647
  2. Changed2 schema fields changedv0.2.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "additionalProperties": true,
      +  "properties": {
      +    "truncated": {
      +      "additionalProperties": true,
      +      "description": "Present only when the answer was shortened to fit the budget.",
      +      "properties": {},
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
  3. First observedv0.1.2

TDQS

A4.5/5.0
Behavior5/5

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

It goes beyond the sparse annotations by disclosing a non-obvious behavioral trait: the comment is attributed to the API key's account, often a service account, and advises reflecting that in the text when relevant. This is exactly the kind of context that helps an agent avoid a subtle mistake.

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?

Two sentences with no filler: the main action is front-loaded, the optional reply behavior follows, and the attribution caveat earns its place. Nothing is redundant or verbose.

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?

Given a simple creation tool, a full input schema, and an output schema, the description is complete. It covers the key behavioral caveat (attribution) that the schema and annotations do not, while the schema documents required fields and output.

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 baseline is 3. The description's 'optionally as a reply to another' largely paraphrases the reply_to schema field and adds little new parameter-level information beyond what the schema already provides.

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 description clearly states the action ('Posts a comment'), the resource ('on a page'), and the optional reply mode, which distinguishes it from comment-list/update/delete siblings. The verb+resource pair is specific and unambiguous.

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?

The description gives clear context for use: post a new comment, optionally as a reply. It does not explicitly name alternatives like update_comment or delete_comment, but the creation semantics are obvious and no exclusion criteria are needed.

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