Skip to main content
Glama

Add wiki comment

add_wiki_comment

Comment on a wiki page, or reply to one of its comments ('replyTo' is a comment id from get_wiki_page). A reply notifies the author of the comment it answers, whether or not they watch the page — no mention needed — and they are told once even if also mentioned. Identify the page by 'pageId', or by 'spaceKey' + 'title'. Markdown is rendered; mention someone as @Their Name, the wiki's own form. Requires permission to comment in that project. Answers with 'notified' (who this actually reaches, the answered author included), 'answered' (for a reply: whose comment it answers, and 'notified' false with a 'reason' when they are not told) and 'unresolvedMentions' (what looked like a mention and reached nobody, each with a reason) — a wrong handle is stored as written and never refused, so that list is the only sign it did not land.

Input Schema

NameRequiredDescriptionDefault
bodyYesComment body as Markdown, which also carries $…$ / $$…$$ LaTeX formulas.
titleNoExact page title, when identifying the page by title.
pageIdNoPage id (as returned by search_wiki).
replyToNoThe comment this one answers, as returned by get_wiki_page.
spaceKeyNoSpace key, when identifying the page by title.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

With annotations only indicating non-read-only and non-destructive behavior, the description adds the notification side effect (author notified once even if also mentioned), the permission requirement, Markdown/mention rendering rules, and the fact that a wrong handle is stored as written and never refused. This is substantial behavioral context beyond the annotations.

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?

It front-loads the action and packs notification, mention, permission, and return-value details without filler. However, it is a dense semicolon-heavy paragraph, so structure could be easier to scan.

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?

No output schema exists, and the description fully explains the return fields 'notified', 'answered', and 'unresolvedMentions', including why 'unresolvedMentions' matters. Given the mutation complexity and auth requirements, it covers what an agent needs to call and interpret the tool.

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 baseline is 3; the description adds that 'replyTo' is a comment id from 'get_wiki_page', that the page can be identified by 'pageId' or 'spaceKey' + 'title', and that the body supports rendered Markdown plus the wiki mention form. It does not document every parameter's full constraints, but it adds useful semantics.

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 first clause gives a specific verb and resource ('Comment on a wiki page') and immediately distinguishes the reply mode via 'replyTo'. It also names where 'replyTo' comes from ('get_wiki_page'), so an agent can tell this apart from a generic comment tool.

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?

It states the two use cases (new comment vs. reply), how to identify the page ('pageId', or 'spaceKey' + 'title'), and the prerequisite permission to comment. It does not explicitly route agents to 'update_wiki_comment' or 'add_comment' for other comment operations, so it is clear but not fully alternative-aware.

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.

Resources