Skip to main content
Glama

Create a project comment

create_comment
Destructive

Create an open Comment on a .tex project file and post it immediately to project collaborators without changing the source file. Later deletion cannot undo prior delivery or reading. Selection offsets may be inferred from quote. Provide exactly one target: fileId or path.

Input Schema

NameRequiredDescriptionDefault
bodyYes
pathNo
quoteNo
fileIdNo
projectIdYes
selectionToNo
contextAfterNo
contextBeforeNo
selectionFromNo

Output Schema

NameRequiredDescriptionDefault
commentYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Goes well beyond the annotations: it discloses that the comment is posted immediately to collaborators and that later deletion cannot undo prior delivery or reading — this explains WHY destructiveHint=true even though no file content is modified, which annotations alone would leave confusing. It also pre-empts the read/write ambiguity with 'without changing the source file'. It doesn't cover permission requirements or limits on later edits.

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?

Four short sentences, purpose front-loaded, then the side-effect warning, then the targeting constraint. Dense but every sentence carries information; the ordering puts the most decision-relevant facts first.

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

Completeness4/5

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

For a 9-parameter mutating tool with an output schema (so returns needn't be described) and annotations that already flag destructive=true, the description supplies the crucial non-obvious facts: immediate delivery, irreversibility of that delivery, no source modification, and the exclusive target rule. Gaps in context/offset parameter meaning keep it from a 5.

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 0%, so the description has to carry the load. It usefully documents the fileId/path mutual exclusion (the oneOf) and the quote-to-selection-offset inference, covering the most confusing parameters. However, body constraints (4000 chars), projectId's role, contextBefore/contextAfter, and selectionFrom/selectionTo range semantics are left entirely to their bare names.

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 (Create) plus resource (an open Comment) and adds meaningful scope: 'on a .tex project file' and 'without changing the source file'. This clearly separates it from edit_file/create_file style writes, though it never explicitly distinguishes itself from the sibling reply_to_comment.

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

Usage Guidelines3/5

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

The line 'Provide exactly one target: fileId or path' is a genuine usage constraint, and 'Selection offsets may be inferred from quote' tells the agent it can skip offset params. But there is no guidance on when to use this versus reply_to_comment or list_comments, and no prerequisites named.

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