Skip to main content
Glama

Comment on a document

heystack_comment

Comment on a document. Requires MCP 2026-07-28.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "heystack_comment"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

C2.6/5.0
Behavior2/5

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

Annotations already declare this is a non-read-only, non-idempotent, non-destructive, closed-world mutation, so the safety profile is covered. The description adds only an environmental prerequisite ('Requires MCP 2026-07-28'), which is genuinely useful, but says nothing about what context the comment is attached to, whether the document must be open first, or what side effects result. For a write tool with zero parameters, that leaves the agent blind about how the mutation is targeted.

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?

Two short sentences, front-loaded with the action, with no filler or repetition. The brevity is not the problem here; the missing detail is, which is scored under other dimensions.

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?

This is a mutation tool with no output schema and no parameters, so the description carries nearly the whole burden of explanation. It states a version requirement but not what the comment is attached to, whether the document must be read first, or what the agent should expect afterward, so it is not sufficient to invoke the tool confidently.

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?

The input schema is empty, which sets the nominal baseline at 4, but the absence of parameters makes implicit targeting the central semantic question: how does the tool know which document and what text to post? The description gives no hint that the target/body come from session context or a currently open document, so the one thing an agent needs explained is omitted.

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

Purpose3/5

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

The description names a concrete action and resource ('Comment on a document'), so the general intent is legible. However, it never says which document, what the comment body is, or how the target is selected, which is critical information for a tool that takes no parameters. It also offers no differentiation from siblings such as heystack_suggest_edit or heystack_submit_contribution.

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?

There is no when-to-use guidance, no prerequisities beyond a version string, and no routing toward alternatives in the sibling set (suggest_edit, submit_contribution, review_suggestion). An agent must guess when commenting is the right action versus proposing an edit.

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