Skip to main content
Glama

Get a space document by its ID

gitbook_get_document_by_id
Read-onlyIdempotent

Retrieve a specific document from a GitBook space using its unique document ID. Provide space ID and document ID to get the document content.

Instructions

Get a space document by its ID. (GET /spaces/{spaceId}/documents/{documentId})

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
spaceIdYesPath parameter: spaceId.
documentIdYesPath parameter: documentId.
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 already declare readOnlyHint, idempotentHint, and openWorldHint. The description adds the HTTP method (GET) but no additional behavioral traits like auth requirements or rate limits. Adequate but minimal added value.

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?

Extremely concise single sentence plus endpoint. Every word is useful, no redundancy. Front-loaded purpose.

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 get operation with annotations covering safety and openness, the description is nearly complete. Missing mention of return format, but output schema is absent.

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?

Input schema has 100% coverage with short descriptions. The description adds little beyond the schema, only providing an example for the 'body' parameter. Baseline 3 is appropriate.

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 clearly states the verb 'Get' and the resource 'a space document by its ID', distinguishing it from sibling 'get' tools for other entities like change requests or pages.

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 description implies usage for retrieving a document by ID but provides no explicit guidance on when to use vs alternatives (e.g., get_computed_document) or prerequisites.

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