Skip to main content
Glama

List change requests

gitbook_list_change_requests
Read-only

List change requests for a space. GitBook REST: GET /spaces/{spaceId}/change-requests.

Input Schema

NameRequiredDescriptionDefault
pageNo1-based page number.
limitNoResults per page.
statusNoFilter by change-request status, e.g. 'open', 'merged', 'draft'.
spaceIdYesThe space id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds only the REST endpoint mapping, which confirms but does not extend the read semantics; it says nothing about default page size, ordering, or total-count behavior that an agent listing results would benefit from.

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?

Two tight sentences: the action and scope come first, the endpoint mapping second. Nothing is redundant or padded.

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 simple read-only list tool with full schema coverage and a readOnly annotation, the description is essentially sufficient. The only modest omissions are pagination/ordering expectations, which are not strictly required to invoke it correctly.

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 description coverage is 100%, so page, limit, status, and spaceId are all documented in the schema itself. The description adds no format or semantics beyond the schema, which is the expected baseline when the schema carries the load.

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 (List) and resource (change requests) with scope ('for a space') and even maps it to the underlying REST endpoint, so the agent knows exactly which operation this is. It does not explicitly differentiate itself from siblings like gitbook_get_change_request or gitbook_search_space, which keeps it just short of a 5.

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 or when-not-to-use guidance, no mention of alternatives (e.g. search_space for cross-space lookups), and no note about pagination or filtering behavior in practice. The 'for a space' phrasing weakly implies spaceId is the selector, but nothing routes the agent between this and its siblings.

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.