Skip to main content
Glama

search_docs

Read-only

Search Ansible documentation manifests to find conceptual guides matching your query. Filter results by source, topic, audience, or core content, and retrieve titles, summaries, and URLs.

Instructions

Search documentation manifests for conceptual guides.

Returns up to 20 matching entries with title, summary, topic, audience, lines, source, and raw URL. On failure returns {"error": str}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYesSearch term to match against documentation titles, summaries, and topics
topicNoFilter by topic tag
sourceNoFilter to a single source (e.g. 'ansible-core')
audienceNoFilter by audience tag
core_onlyNoIf true, only return entries marked as core

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

Consistent with readOnlyHint=true; specifies return limit (20 entries) and response fields, plus error format. No contradictions.

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 concise sentences: first states purpose, second details output and error handling. No superfluous content.

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?

Complete for a search tool: input schema fully documented, output schema implied via listed fields, annotations present, and description covers all needed context.

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

Parameters4/5

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

Schema already describes all 5 parameters fully (100% coverage). The description adds value by listing returned fields and size limit, going beyond schema.

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?

Explicitly states it searches for 'conceptual guides' in 'documentation manifests', differentiating from sibling tools that search collections, modules, or plugins.

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?

Implicitly indicates use for documentation search via 'conceptual guides', but lacks explicit when-to-use or when-not-to-use guidance relative to siblings like fetch_doc or search_collections.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/leogallego/ansible-know-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server