Skip to main content
Glama
Sign In

FeatureOS

by io.github.featureos
OverviewDiscussionsAdmin

Update comment

update_comment
Destructive

Update an existing comment. The comment text is REQUIRED and REPLACES the entire comment body — pass the complete new text, not a diff or append (there is no partial-text mode). Get comment_id from list_comments or get_comment. pinned: pass true/false to change it, omit to leave it unchanged.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "comment_id": "<comment_id>",
      "comment": "<comment>"
    },
    "name": "update_comment"
  }
}

Input Schema

NameRequiredDescriptionDefault
pinnedNoSet to True to pin the comment, False to unpin.
commentYesThe updated comment text. Full replacement text — overwrites the existing comment body.
comment_idYesThe ID of the comment to update.

Output Schema

NameRequiredDescriptionDefault
commentNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already flag destructiveHint=true and openWorldHint=true, so the bar is lower, yet the description adds the crucial behavioral fact that the comment body is fully replaced with no partial/append mode. That is the main destructive risk an agent needs before calling. It does not mention permissions or how `pinned` interacts with the write, so it is not exhaustive.

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?

The replacement warning is front-loaded in the first sentence, followed by the id-lookup hint and the `pinned` rule. Every sentence carries actionable information with no filler.

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?

With an output schema present, return values need not be described, and all three parameters are documented plus qualified in the description. For a three-parameter destructive update tool, nothing essential is missing.

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; the description rises above it by clarifying that `comment` is a full replacement rather than a diff or append, and by defining the omit-vs-explicit-false semantics of `pinned`, which the schema only partially conveys. Both clarifications add meaning an agent would otherwise have to guess.

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?

The description states a specific verb and resource ("Update an existing comment") and immediately identifies the fields it can change, so an agent can tell it apart from create_comment or get_comment. It stops short of explicitly naming sibling alternatives, which keeps it from a 5.

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 gives concrete prerequisite guidance — obtain comment_id from list_comments or get_comment — and states the conditional rule for `pinned` (pass true/false to change, omit to leave unchanged). It does not cover when an update is preferable to deleting and recreating, but the practical selection path is clear.

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

All FeatureOS toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources