Skip to main content
Glama

update_comment

Modify existing comments in Storyblok discussions by providing updated message content and structure.

Instructions

Updates a comment in a discussion via the Storyblok Management API.

Required:

  • discussion_id: Numeric ID of the discussion.

  • comment_id: Numeric ID of the comment.

Payload:

  • message_json: Required. Array of message objects, each with keys "type", "text", "attrs".

  • message: Optional string or null.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
discussion_idYesNumeric ID of the discussion
comment_idYesNumeric ID of the comment
message_jsonYesRequired. Array of message objects, each with keys "type", "text", "attrs"
messageNoOptional string or null
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It states this is an update operation but doesn't mention permission requirements, whether changes are reversible, rate limits, or what happens to existing comment data not included in the payload. This leaves significant gaps for a mutation tool.

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?

The description is appropriately sized with clear sectioning ('Required:' and 'Payload:'). However, the repetition of schema information in the description could be considered somewhat wasteful, preventing a perfect score.

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

Completeness2/5

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

For a mutation tool with no annotations and no output schema, the description is insufficient. It doesn't explain what the tool returns, error conditions, authentication requirements, or side effects. The 100% schema coverage helps with parameters but doesn't compensate for missing behavioral context.

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 schema already documents all parameters thoroughly. The description repeats some parameter information but doesn't add meaningful context beyond what's in the schema descriptions. This meets the baseline for high schema coverage.

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 clearly states the action ('Updates a comment') and resource ('in a discussion via the Storyblok Management API'), providing specific verb+resource. However, it doesn't explicitly differentiate from sibling tools like 'create_comment' or 'delete_comment', which would be needed for a perfect score.

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?

The description provides no guidance on when to use this tool versus alternatives like 'create_comment' or 'delete_comment'. It mentions required parameters but offers no context about prerequisites, error conditions, or appropriate use cases.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/hypescale/storyblok-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server