Get space
gitbook_get_spaceGet full details of a space by its ID. GitBook REST: GET /spaces/{spaceId}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| spaceId | Yes | The space id. |
gitbook_get_spaceGet full details of a space by its ID. GitBook REST: GET /spaces/{spaceId}.
| Name | Required | Description | Default |
|---|---|---|---|
| spaceId | Yes | The space id. |
Changes observed during successful MCP inspections.
Input schema / $schemaPrevious value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already tells the agent this is a safe read, and the description adds nothing behavioral beyond it — no note on what 'full details' includes, whether the call fails on unknown IDs, or any permission scope. The only addition (the REST endpoint GET /spaces/{spaceId}) is API trivia rather than behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, action front-loaded, no filler. The REST endpoint mapping is the only arguably optional clause and it is kept terse.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-parameter read tool with annotations covering the safety profile, the definition is nearly sufficient. The one remaining gap is that no output schema exists, so the description could say what 'full details' returns, but this is a minor omission.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the single parameter is documented in the schema as 'The space id.' The description's 'by its ID' merely restates the schema, adding no format, source, or acquisition guidance. Baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Get full details of a space') and pins the lookup key ('by its ID'), which implicitly separates it from the list_/search_ siblings. It does not name any sibling explicitly, so differentiation is inferred rather than stated.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The 'by its ID' phrasing implies you should call this when you already hold a spaceId, but there is no explicit when-to-use guidance, no mention of gitbook_search_space for name-based lookup, and no statement of what to do if the ID is unknown.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.