Skip to main content
Glama

List comments

gitbook_list_comments
Read-only

List top-level comments posted on a space. GitBook REST: GET /spaces/{spaceId}/comments.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo1-based page number.
limitNoResults per page.
statusNoFilter by comment status.
spaceIdYesThe space id.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the read-only nature is known. The description adds the behavioral nuance that only 'top-level' comments are returned, which is useful context. However, it does not disclose behavior around pagination, sorting, or how the status filter affects results, so the added value is limited.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description consists of two short, direct sentences. The first states the action and resource clearly, and the second provides the exact REST endpoint for reference. There is no fluff or redundancy, making it highly efficient and easy to parse.

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

Completeness3/5

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

For a list operation with four parameters and no output schema, the description is adequate but not comprehensive. It clearly states the purpose and endpoint but does not describe the response shape, pagination defaults, or valid status values. The absence of an output schema and enum definitions means the agent must infer some details from the REST endpoint.

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 has 100% coverage, with all four parameters individually described. The description does not add any parameter-specific meaning beyond what the schema provides. It mentions the endpoint but not how parameters map to the request, so it relies on the schema for parameter semantics.

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 uses a specific verb 'List' with a clear resource 'top-level comments' scoped to 'a space'. It directly states the REST endpoint, which unambiguously identifies the operation. Among siblings, this is the only comment-related tool, so there is no ambiguity.

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?

The description makes clear this tool is for listing top-level comments on a space, which implies when to use it. It does not explicitly name alternatives or exclusions, but since no sibling tool handles comments, the context is effectively unambiguous. A clear usage scenario is communicated without needing explicit 'when not to use' guidance.

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.

TDQS

A3.9/5.0
Disambiguation5/5

Each tool targets a distinct resource and action (e.g., get vs list vs search, change-request vs page vs space), so there is no meaningful overlap or ambiguity between tools.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern with a uniform gitbook_ prefix (e.g., gitbook_list_spaces, gitbook_get_page, gitbook_create_change_request). The naming is predictable and systematic.

Tool Count4/5

14 tools is slightly high but still reasonable for a documentation platform API covering resources like spaces, pages, change requests, collections, organizations, and search. Each tool has a clear purpose, though the set feels a bit broad with several read-only operations.

Completeness3/5

The set is heavily read-focused and lacks essential write operations for pages and spaces (create, update, delete), which are core to GitBook's purpose. It does cover change-request lifecycle partially (create, list, update) but omits merge/delete and page editing, leaving noticeable gaps.