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

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.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered, and the 'GET /spaces/{spaceId}/search' reference is consistent with a read. Beyond that the description adds little: no pagination behavior (page/limit exist), no result ordering, no rate limits, and no note on what is matched (title vs body). Adequate but thin for a search endpoint.

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?

Two short sentences with zero filler; the capability statement is front-loaded and the REST reference is a compact secondary detail. Nothing is redundant with the name or title.

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?

With no output schema, the description is the only place return shape could be described, and it says nothing about what results contain or how pagination is signalled. Annotations plus the fully documented schema cover safety and inputs, so it is minimally complete but leaves a real gap for a search tool.

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%, so spaceId, query, page, and limit are already documented in the schema. The description adds no syntax, matching-mode, or pagination semantics beyond it, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource with scope: 'Full-text search across all pages in a space.' An agent immediately knows this is content search scoped to one space. It does not, however, distinguish itself from the sibling gitbook_search_organization, which is the main source of ambiguity between the two search tools.

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 space-scoped phrasing implies when this tool is appropriate (finding pages by content within a known space), but there is no explicit when-to-use/when-not statement and the sibling gitbook_search_organization is never named as the alternative for org-wide search. Usage is inferable rather than guided.

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.