Skip to main content
Glama

Turn comments on or off for a page

set_comments
Idempotent

Turn click-to-pin comments on or off for a page. While on, anyone who can view the page can click a spot on it to comment once they sign in with their email (on a work-email-locked page, their viewing sign-in is enough); the maker gets an email per comment. Off hides comments without deleting them. Off by default. Returns { ok, page_id, commentsEnabled }. Use it when the human asks for feedback or review on a page.

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": {
      "page_id": "<page_id>",
      "enabled": "<enabled>"
    },
    "name": "set_comments"
  }
}

Input Schema

NameRequiredDescriptionDefault
enabledYestrue turns comments on, false turns them off.
page_idYesThe page id: the `id` field from publish_page or list_pages (also the last path segment of the page URL, …/docs/<page_id>). Only pages in the connected maker's space are visible.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already declare idempotent, non-destructive mutation; the description goes well beyond them by explaining who can comment (anyone with view access after email sign-in, with a work-email-locked exception), that the maker gets an email per comment, that turning off hides rather than deletes, and that off is the default. It even names the response fields, which no output schema provides.

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?

Behavior and the usage trigger are front-loaded, and the return shape and default are tucked in efficiently. The parenthetical about work-email-locked pages is dense and slightly interrupts flow, but every sentence carries real information.

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?

For a two-parameter toggle with no output schema, the description supplies permissions model, side effects, default state, and return fields — everything an agent needs to call it correctly and describe the outcome.

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 coverage is 100%, so both parameters are already fully documented and the description need only match that baseline. It does add one genuine semantic detail for enabled=false ('hides comments without deleting them'), but says nothing new about page_id or the on-state beyond what the schema states.

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?

Opens with a specific verb and resource: 'Turn click-to-pin comments on or off for a page.' That clearly distinguishes it from siblings like list_comments, resolve_comment, and delete_page without the agent needing to open any schema.

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?

Gives an explicit trigger: 'Use it when the human asks for feedback or review on a page.' It does not name exclusions or contrast with resolve_comment/list_comments, but the positive usage condition is concrete enough to select the tool in most cases.

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