Skip to main content
Glama

Aqua Flow guides

List FAQ

list_faq
Read-onlyIdempotent

List the questions and answers published for a product category (for example Tami 4 filters or UV lamps). Use when the user wants quick answers about a product family rather than one product.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_faq"
  }
}

Input Schema

NameRequiredDescriptionDefault
category_idNoProduct category id; omit to get every category that has a FAQ

Output Schema

NameRequiredDescriptionDefault
faqYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered and the description does not contradict it. The description adds only the framing that results are published Q&A per category; it says nothing about ordering, volume, or what happens when a category has no FAQ, which annotations cannot tell the agent.

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 sentences, zero filler: the capability statement comes first, followed immediately by the selection guidance. The example is brief and illustrative rather than padding.

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

Completeness4/5

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

This is a simple read-only single-parameter tool with full annotation coverage and an output schema, so the description need not explain return values or safety. It is essentially complete; only the absence of any hint about result ordering or empty-category behavior is a minor residual gap.

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?

Schema description coverage is 100%, and the single optional category_id is already documented as 'omit to get every category that has a FAQ'. The description adds no format, id-discovery, or filtering nuance beyond that, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb and resource ('List the questions and answers') and scopes it to a product category with a concrete example ('Tami 4 filters or UV lamps'). It distinguishes the content type by contrast ('quick answers about a product family rather than one product'), though it never names the actual siblings get_guide or search_guides, so an agent must still infer the boundary from the topic rather than an explicit statement.

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?

The clause 'Use when the user wants quick answers about a product family rather than one product' gives a clear positive trigger and an implicit contrast case (single-product lookups). There are no explicit exclusions or named alternatives, so an agent facing a guide-search intent must decide on its own, which keeps this below a 5.

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