Skip to main content
Glama

Search organization

gitbook_search_organization
Read-only

Search content across an entire organization. GitBook REST: GET /orgs/{organizationId}/search.

Input Schema

NameRequiredDescriptionDefault
pageNo1-based page number.
limitNoResults per page.
queryYesThe full-text search query (required).
organizationIdYesThe organization 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

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, and the description's 'GET /orgs/{organizationId}/search' corroborates that this is a read-only operation. However, it says nothing about pagination behavior despite exposing page/limit, nor about what content is indexed or whether results span spaces and collections.

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?

Two short sentences with no padding, and the purpose is front-loaded before the API mapping. The REST endpoint reference is mildly useful for cross-referencing docs, though it is not essential.

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?

For a four-parameter search tool with no output schema, the description leaves the result shape, paging semantics, and result-scope unstated. Annotations cover the safety profile, but an agent still lacks enough to know what comes back or how paging behaves.

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 all four parameters (query, organizationId, page, limit) are already documented in the schema. The description adds no syntax, format, or semantic detail beyond that, 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+resource ('Search content') and scopes it to 'an entire organization', which implicitly distinguishes it from the sibling gitbook_search_space. It is clear what the tool does, though it never names the alternative explicitly.

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 scope phrase 'across an entire organization' implies when org-wide search is appropriate versus space-scoped search, but there is no explicit when-to-use, when-not-to-use, or alternative-naming guidance. Usage must be inferred from the scope wording.

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.