Skip to main content
Glama

Get a space computed document

gitbook_get_computed_document

Retrieve the computed document of a GitBook space via API. Get the rendered content for a specified space ID.

Instructions

Get a space computed document. (POST /spaces/{spaceId}/content/computed/document)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
spaceIdYesPath parameter: spaceId.
bodyNoRequest body as a JSON object, per the GitBook API for this operation.
Behavior2/5

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

The description says 'Get' implying read-only, but annotations set readOnlyHint=false, creating a contradiction. The HTTP method (POST) also suggests mutation. No disclosure of what 'computed' entails or side effects.

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?

One sentence plus the API endpoint is concise. However, including the HTTP method incongruously (POST) could be confusing.

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?

No output schema exists, yet the description does not explain what a computed document is or what the return value contains. The body parameter is underspecified given its complexity.

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 coverage is 100%, but the description adds minimal value: it simply restates the schema field descriptions ('Path parameter: spaceId', 'Request body as a JSON object...'). No further semantic or formatting guidance for the complex body parameter.

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 specific resource 'space computed document', distinguishing it from sibling tools like get_page, get_document_by_id, and get_computed_revision.

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 on when to use this tool versus alternatives. With many sibling tools for getting documents, revisions, and pages, the description should indicate scenarios for using a computed document.

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