Skip to main content
Glama

Get a space file by its ID

gitbook_get_file_by_id
Read-onlyIdempotent

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

Instructions

Get a space file by its ID. (GET /spaces/{spaceId}/content/files/{fileId})

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
spaceIdYesPath parameter: spaceId.
fileIdYesPath parameter: fileId.
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?

The annotations already declare readOnlyHint, idempotentHint, and openWorldHint, which cover the safety profile. The description adds the HTTP method and path but no additional behavioral traits such as rate limits, authentication needs, or edge cases.

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?

The description is concise—one sentence and the HTTP path. It is front-loaded with the purpose. Could benefit from slightly more structure or detail, but is efficient.

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?

Given the tool's simplicity (get by ID) and rich annotations, the description is nearly sufficient. However, the lack of an output schema or description of the return format means the agent must infer the response structure, which is a gap especially with the nested body parameter.

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% with descriptions for spaceId and fileId. The description does not add meaning beyond the schema; the body parameter is mentioned as 'optional query parameters' but no specifics. 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 action 'Get a space file by its ID' and includes the HTTP path, distinguishing it from other retrieval tools. The verb 'Get' and the specific resource 'space file' are unambiguous.

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 file by ID but provides no explicit guidance on when to use this tool versus alternatives or any exclusions. No context about prerequisites or limitations.

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