Skip to main content
Glama

List all backlink locations of a change request page

gitbook_list_change_request_page_backlinks
Read-onlyIdempotent

Retrieve all backlink locations for a specific page within a change request to review references before finalizing edits.

Instructions

List all backlink locations of a change request page. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/content/page/{pageId}/backlinks)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
spaceIdYesPath parameter: spaceId.
changeRequestIdYesPath parameter: changeRequestId.
pageIdYesPath parameter: pageId.
bodyNoOptional query parameters as a JSON object (e.g. { limit, page }).
Behavior3/5

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

Annotations declare readOnlyHint, idempotentHint, and openWorldHint, covering safety. The description adds the HTTP path (GET) and confirms it lists items, but lacks details like pagination behavior or response format. No contradiction with annotations.

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?

Description is one line plus the HTTP path, concise and front-loaded. It could be more structured but efficiently conveys the core action.

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?

With no output schema, the description should explain what 'backlink locations' means and mention pagination. It does not, leaving gaps for a list operation. Annotations cover safety but not completeness.

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 the schema fully documents the parameters. The description adds no additional meaning beyond what's in the schema. Baseline score of 3 is appropriate.

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?

The description states it lists backlink locations for a change request page, which is specific. It includes the HTTP method and path, adding clarity. However, it does not explicitly differentiate from siblings like gitbook_list_change_request_links or gitbook_list_space_page_backlinks, but the name and resource are distinct enough.

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?

No guidance is provided on when to use this tool versus alternatives. The description simply states what it does without mentioning context or exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/HoYongJin/gitbook-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server