Skip to main content
Glama

Search the Cactal documentation

docs_search
Read-onlyIdempotent

Search the Cactal product documentation: concepts, guides, agent workflows, platform limits, and the API reference. Returns matching Markdown excerpts with page paths; read a full page with the docs read operation. Consult the docs before non-trivial or unfamiliar work such as source-code editing, publishing, or CMS schema changes.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "query": "<query>"
    },
    "name": "docs_search"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryYesPlain-language question or keywords, for example "how does publishing work".

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=false, and destructiveHint=false, so safety behavior is well covered. The description adds useful return context: matching Markdown excerpts with page paths, plus the next step of using docs_read for a full page. It does not discuss ranking, result limits, or indexing freshness, which are minor gaps for a search tool.

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 compact sentences are front-loaded with the core purpose, followed by return behavior and guidance. Every sentence adds distinct value: scope, output/next step, and usage advice.

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?

For a simple search tool with one fully documented parameter and rich annotations, the description supplies the remaining needed context: what corpus is searched, what is returned, and how to follow up with docs_read. Nothing an agent needs in order to call it correctly appears to be missing.

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?

There is a single required query parameter and schema description coverage is 100%, so the schema already carries the parameter documentation, including a plain-language example. The description does not add meaning about query syntax or search behavior beyond what the schema provides, so baseline 3 applies.

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?

States a specific verb (Search) and resource (Cactal product documentation) with concrete content domains: concepts, guides, agent workflows, platform limits, and API reference. It also distinguishes itself from the sibling tool docs_read by explaining that search returns excerpts while full pages are read with the docs read operation.

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?

Gives clear when-to-use guidance: consult docs before non-trivial or unfamiliar work such as source-code editing, publishing, or CMS schema changes. It also names the related alternative, docs_read, for reading full pages after searching. It does not state explicit exclusions or when-not-to-use cases, but the practical context is clear.

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