Skip to main content
Glama

Search Space Documents Tool

search-space-documents
Read-only

Use this when the user wants to find pages, docs, documents, or content inside one specific Space. Read-only: searches the selected Space and returns matching document snippets without changing content. Requires numeric space_id from list-spaces.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for pagination
queryYesSearch query (minimum 2 characters)
per_pageNoNumber of results per page
space_idYesThe numeric ID of the space to search in. Call list-spaces first.
highlightNoWhether to highlight search terms in results

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Explicitly states 'Read-only' and 'without changing content', which aligns with the readOnlyHint annotation. It also describes the core behavior (searches and returns matching document snippets). No additional side effects or limitations are mentioned, but the description adds value beyond the annotations.

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 two concise sentences with no redundant information. It effectively communicates the purpose, read-only nature, and the key prerequisite without wasting words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has no output schema, the description adequately states that it returns 'matching document snippets'. Combined with parameter explanations, it provides sufficient context for an agent to invoke it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

All 5 parameters have clear descriptions in the schema (100% coverage). The description adds extra context for space_id, specifying it must be numeric and obtained from list-spaces, which goes beyond the schema's basic description.

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?

Clearly states the tool 'finds pages, docs, documents, or content' within a specific Space, using a specific verb and resource. It also distinguishes the scope by emphasizing 'one specific Space' and requiring space_id from list-spaces.

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?

Provides a clear when-to-use condition ('when the user wants to find... inside one specific Space') and a prerequisite (requires numeric space_id from list-spaces). However, it does not explicitly mention alternatives like global-search for cross-space searching, leaving some inference to the agent.

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.

Resources