Skip to main content
Glama
Sign In

AGILEX Docs

by ai.agilex.service
OverviewDiscussionsAdmin

search_docs

Full-text search over the official AGILEX product documentation.

    Use this first for any question about AGILEX hardware: pinouts, CAN
    protocol details, baud rate, firmware upgrade, error codes, LED/beep
    meanings, installation, calibration, SDK usage.

    Args:
        query: Chinese or English keywords. Include the product name
            (piper / pika / nero / ranger / limo / scout / bunker / hunter /
            tracer / umr) plus the concept, e.g. "piper CAN 波特率".
        limit: 1-25 results, default 8.
        space: optional space slug or name fragment to narrow the search,
            e.g. "agx-chassis-manual-cn-en" or "底盘使用手册".

    Returns JSON: {query, count, results:[{doc_id,title,space,url,score,chars,snippet}]}.
    ``doc_id`` is what ``get_doc`` expects.

Input Schema

NameRequiredDescriptionDefault
limitNo
queryYes
spaceNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior4/5

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

With no annotations, the description carries the disclosure burden and does well: it describes the returned JSON shape and the practical link from doc_id to get_doc. It omits permission/auth requirements, rate limits, and behavior on zero results, which are the remaining gaps for a tool with zero annotation coverage.

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?

The primary purpose and usage instruction are front-loaded, and the Args block is scannable. It is somewhat verbose, restating defaults already implied by the schema, but no sentence is genuinely wasted.

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 three-parameter read-only search tool with an existing output schema, nothing essential is missing: it covers when to use it, how to build a query, and how to chain into get_doc. Complexity is low and the description matches it.

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?

Schema coverage is 0%, so the description must compensate, and it does: query explains language support plus the exact product-name vocabulary with an example query, limit specifies the 1-25 range and default 8, and space gives concrete slug and Chinese-name examples.

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 and resource ('Full-text search over the official AGILEX product documentation') and enumerates the content domains it covers (pinouts, CAN protocol, firmware, error codes). It is clearly distinguishable from siblings like get_doc/list_docs because it is the entry point search 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?

'Use this first for any question about AGILEX hardware' gives explicit priority ordering versus siblings, and the note that 'doc_id is what get_doc expects' names the natural follow-up tool. The trigger conditions are concrete and leave little to inference.

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

All AGILEX Docs toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources