Skip to main content
Glama

confluence_get_comment

Fetch a single Confluence footer or inline comment by its ID, with configurable body format and version details.

Instructions

Primitive: get one footer or inline comment by ID. For the comment plus its bounded reply tree, prefer confluence_get_comment_thread.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
versionNo
max_charsNo
comment_idYes
body_formatNostorage
comment_typeNofooter
include_versionsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It usefully clarifies that this is a primitive single-comment fetch that does not include the reply tree, but it does not disclose response shape, error behavior, or auth/versioning caveats.

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 short sentences with no wasted words. The primary scope is front-loaded, and the sibling alternative is stated immediately after.

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

Completeness3/5

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

For a simple getter with 6 parameters and no output schema, the description gives enough to select the tool and know its basic scope, but it is not fully complete: parameter semantics and return behavior are left to inference.

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

Parameters2/5

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

Schema description coverage is 0%, and the description only adds meaning for comment_id and the footer/inline distinction. It leaves version, max_chars, body_format, and include_versions unexplained, so it does not sufficiently compensate for the schema's lack of descriptions.

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 and resource: get one footer or inline comment by ID. It also distinguishes itself from the thread-fetching sibling by name, so an agent can tell exactly what this primitive does.

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

Usage Guidelines5/5

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

Explicitly instructs when to prefer the alternative: for the comment plus its bounded reply tree, use confluence_get_comment_thread. This gives clear selection guidance for the primary use case.

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