Skip to main content
Glama

list_comments

Read-onlyIdempotent

List top-level comments on a task, project, proposal, or issue. Exactly one of taskId, projectId, proposalId, issueId, or companyId must be set. Returns root comments with their direct replies + author info. Newest comments first. Each root comment carries url, the link in the Onplana web app to the task, project, issue, proposal or client it is on.

Input Schema

NameRequiredDescriptionDefault
taskIdNoLimit to a task
issueIdNoLimit to an Issue (Issue Log)
companyIdNoLimit to a client company (Onplana Services)
projectIdNoLimit to a project
proposalIdNoLimit to a proposal

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / companyId
      Added value: +{
      +  "description": "Limit to a client company (Onplana Services)",
      +  "type": "string"
      +}
  2. Added

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the safety profile is covered. The description adds meaningful behavior beyond that: it returns root comments plus direct replies with author info, ordered newest-first, each carrying a web-app url. Pagination and result limits are unstated, keeping it from a 5.

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?

Three sentences, front-loaded with purpose then constraint then return shape. The final sentence about the url field is a bit wordy for what it conveys, but it does carry return-format information that has no output schema to fall back on.

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?

With no output schema, the description carries the return-shape burden and does so reasonably: root comments, replies, author info, ordering, and the url field. It omits pagination/limit behavior and reply depth limits, which an agent would want for a list tool on potentially large comment threads.

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 description coverage is 100%, so the baseline is 3, but the description adds a genuine constraint not encoded in the schema: 'Exactly one of taskId, projectId, proposalId, issueId, or companyId must be set.' The schema marks nothing required and has no oneOf, so this mutual-exclusivity rule is real added value.

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?

The description leads with a specific verb and resource ('List top-level comments') and enumerates the exact entity types it operates on (task, project, proposal, issue), which clearly separates it from create_comment and edit_comment. An agent can identify the tool without opening the 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?

It states the scoping constraint that exactly one of the five IDs must be set, giving clear invocation context. It stops short of naming alternatives (e.g., list_mentions, list_recent_activity) or noting when this tool is not appropriate, so it is not a full 5.

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.