Skip to main content
Glama

Frequently asked questions

list_faq
Read-onlyIdempotent

The questions and answers published on the PolarJay FAQ page. Optionally filtered by words in the question or the answer.

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
queryNoWords to look for, for example trial, query or cancel
localeNoAnswer language: en (English).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / locale / enum
      Previous value: -[
      -  "en"
      -]New value: +[
      +  "es",
      +  "en"
      +]
  2. Changed2 schema fields changed
    • changedInput schema / properties / locale / description
      Previous value: -"Answer language: es (Spanish) or en (English). Defaults to en."New value: +"Answer language: en (English)."
    • changedInput schema / properties / locale / enum
      Previous value: -[
      -  "es",
      -  "en"
      -]New value: +[
      +  "en"
      +]
  3. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered by structured data. The description adds one genuinely useful behavioral detail: the filter matches words in either the question or the answer, not just the title. It says nothing about result ordering, empty-result behavior, or what a returned record looks like.

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?

Two tight sentences with the resource and the optional filter front-loaded; nothing is padded. The first sentence is a bare fragment, which costs a little clarity about what action the tool performs.

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?

For a two-parameter, no-required-argument read tool with full annotation and schema coverage, the description covers the source content and the filter scope adequately. Only minor gaps remain — whether an unfiltered call returns the whole FAQ and how results are shaped — and those are largely implied by 'optionally filtered' plus the closed-world annotation.

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 coverage is 100%, so both the query string and the locale enum are already documented, including the example terms and the language meaning. The description reinforces that the filter spans question and answer text but adds no syntax, matching rules, or locale semantics beyond the schema — 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 names a specific resource — the Q&A pairs published on the PolarJay FAQ page — and states the filtering behavior. It is clearly distinguishable from siblings like get_pricing or how_to_start, though the sentence is a noun phrase and never uses a verb to say it 'retrieves' or 'lists' the FAQs.

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

Usage Guidelines3/5

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

The phrase 'Optionally filtered by words' implies two modes (browse everything, or search by keyword), which is useful implied guidance. However, there is no explicit statement of when to prefer this over get_page or how_to_start, and no exclusions or prerequisites are given.

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