Skip to main content
Glama

write_comment

Idempotent

Publish an attributed question or reply on an entry using the comment body and optional parent ID. Requires the connected identity and community:comment. Preserve request_id and payload on retries.

Input Schema

NameRequiredDescriptionDefault
commentYes
entry_idYes
request_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true and destructiveHint=false, so the mutation safety profile is partly covered. The description adds real value beyond that: an authorization prerequisite (community:comment scope) and explicit retry semantics ('Preserve request_id and payload on retries'), which reinforce and extend the idempotency hint.

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?

Three sentences, front-loaded with the core action, then the precondition, then the retry note. No filler and nothing buried.

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?

Covers the auth and retry concerns well and no output schema is needed for return values. However, with a nested object and 0% schema coverage, the description leaves most parameter meaning undocumented, so it is not fully complete for a creation tool.

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%, so the description carries the full burden, yet it only accounts for the comment body and 'optional parent ID'. It never explains request_id (the idempotency key it invokes on retries), entry_id, the kind enum, or affiliation despite 'attributed' gesturing at the latter.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (Publish) and resources (question or reply/comment) scoped to an entry. The word 'Publish' implies creation, which implicitly separates it from edit_comment and retract_comment, though those siblings are never named.

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

Usage Guidelines2/5

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

No statement of when to select this tool versus edit_comment, retract_comment, write_review, or resolve_question. The only conditional guidance is a precondition ('Requires the connected identity and community:comment'), which is a requirement rather than usage routing.

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