Skip to main content
Glama

Search space

gitbook_search_space
Read-only

Full-text search across all pages in a space. GitBook REST: GET /spaces/{spaceId}/search.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo1-based page number.
limitNoResults per page.
queryYesThe full-text search query (required).
spaceIdYesThe space id.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the agent knows it's a safe read operation. The description adds the scope ('across all pages in a space') and the underlying REST method, which provides useful context beyond annotations. However, it does not disclose pagination behavior, result format, or rate limits, so it does not exceed the minimal bar for additional 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.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is exactly two sentences: one stating the tool's function, and one providing the API endpoint. Every word contributes to clarity, with no filler or redundancy. It is front-loaded with the core purpose and keeps the technical reference concise.

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?

The tool is straightforward (search with pagination) and has full parameter documentation plus readOnlyHint. While there is no output schema, the description does not explain return values, but for a full-text search tool this is not a critical omission given the simplicity. The context is adequate for an agent to invoke it correctly, though a brief note on result structure would elevate 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%, meaning all four parameters (spaceId, query, page, limit) are documented in the input schema. The description adds no new parameter-level information beyond what the schema already provides. The mention of 'full-text search' aligns with the query parameter's schema description, so it does not meaningfully enhance understanding.

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 tool's function: 'Full-text search across all pages in a space.' It specifies a distinct verb ('search') and resource ('space'), and differentiates from sibling tools like search_organization by explicitly scoping to a space. The REST endpoint reference further anchors its purpose.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context that this searches within a specific space, implying when to use it (space-scoped search). However, it does not explicitly mention alternatives or when not to use it, such as noting that organization-wide search would use gitbook_search_organization. Still, the context is sufficiently clear for an agent to select it appropriately.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A3.9/5.0
Disambiguation5/5

Each tool targets a distinct resource and action (e.g., get vs list vs search, change-request vs page vs space), so there is no meaningful overlap or ambiguity between tools.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern with a uniform gitbook_ prefix (e.g., gitbook_list_spaces, gitbook_get_page, gitbook_create_change_request). The naming is predictable and systematic.

Tool Count4/5

14 tools is slightly high but still reasonable for a documentation platform API covering resources like spaces, pages, change requests, collections, organizations, and search. Each tool has a clear purpose, though the set feels a bit broad with several read-only operations.

Completeness3/5

The set is heavily read-focused and lacks essential write operations for pages and spaces (create, update, delete), which are core to GitBook's purpose. It does cover change-request lifecycle partially (create, list, update) but omits merge/delete and page editing, leaving noticeable gaps.