Skip to main content
Glama

search_docs

Read-only

The AXL product documentation (docs.axl.tech, the knowledge base an admin reads) — searchable, and readable in full. Use it for PRODUCT questions the API surface cannot answer: what a feature is, which flow it belongs to, what the business rules are, what the UI calls the thing the user just asked about, whether the platform can do X at all. It does NOT document the API — for operations, bodies and field semantics use capability_map / list_recipes / get_operation_schema. TWO STEPS: (1) search_docs(query="…") returns a ranked shortlist — title, UI section, the article's own summary, a matched snippet — and NOT the articles; (2) pick what looks relevant and call search_docs(slugs="slug-a,slug-b") to read those in full. Call with no arguments for the section outline, or section="CRM" to list one section. Articles are English-only.

Input Schema

NameRequiredDescriptionDefault
limitNoMax search hits (default 8, max 25).
queryNoNatural-language question or keywords, e.g. 'why did my mailing not reach a contact' or 'subscription auto renewal'. Returns a shortlist, never article bodies.
slugsNoComma-separated article slugs to return IN FULL (from a previous search's 'slug', from a recipe's docs[].slug, or from a docs.axl.tech URL). Max 3 per call.
sectionNoOptional sidebar-section filter, e.g. 'CRM', 'Sales', 'Mail and mailings', 'CRM / Contact card'. With no query it lists that section's articles.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, non-destructive, closed-world), and the description adds substantial behavior beyond them: search returns a ranked shortlist and NOT article bodies, full reads require a second call with slugs, max 3 slugs per call, English-only articles, and the no-argument/section listing behavior.

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?

Long but tightly structured and front-loaded: identity, use/don't-use, then a numbered two-step procedure. Every clause carries information (scope, sourcing of slugs, limit, language constraint) with no filler or restatement of the name.

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?

With no output schema, the description compensates by describing the return shape of a search (title, UI section, article summary, matched snippet) versus a full read. Combined with the usage routing and slug-sourcing rules, an agent has everything needed to call both modes correctly.

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 description coverage is 100%, so the schema documents all four parameters, but the description still adds cross-call semantics the schema cannot: that slugs should come from a previous search's 'slug', a recipe's docs[].slug, or a docs.axl.tech URL, and that query+slugs are the two halves of a workflow rather than independent filters.

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/read) and resource (AXL product documentation), and explicitly distinguishes itself from the API-side siblings by naming capability_map, list_recipes and get_operation_schema. An agent can tell immediately this is the product-docs tool, not the API tool.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit when-to-use ('PRODUCT questions the API surface cannot answer: what a feature is, which flow it belongs to, business rules, UI naming') and when-not-to-use, routing API questions to named alternatives. The TWO STEPS block dictates the exact call sequence.

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