Skip to main content
Glama

Generate FAQ pairs grounded in a text with checked quotes

text_faq
Read-only

Up to 15 question and answer pairs written from a text (max 30,000 characters). Each answer carries a supporting quote that is checked against the text; pairs whose quote does not occur in the text are dropped. Model-written: review the questions before publishing. Related tools on this server, for a different need: text_chunk when you need to generate overlapping text chunks with character offsets; text_headlines when you need to generate headlines for a text or topic in a chosen style. Price: $0.002 per successful call, paid with x402 (USDC on Base, Solana and 10 more networks); failed calls are not charged.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "text": "<text>"
    },
    "name": "text_faq"
  }
}

Input Schema

NameRequiredDescriptionDefault
textYesSource text (max 30,000 characters)
countNoNumber of pairs, 1-15 (default 5)

Output Schema

NameRequiredDescriptionDefault
faqNo
noteNo
countNo
droppedNo
checkedAtNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • addedOutput schema / properties / checkedAt
      Added value: +{}
    • addedOutput schema / properties / count
      Added value: +{}
    • addedOutput schema / properties / dropped
      Added value: +{}
    • addedOutput schema / properties / faq
      Added value: +{}
    • addedOutput schema / properties / note
      Added value: +{}
  2. Added

TDQS

A4.4/5.0
Behavior5/5

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

Beyond the readOnlyHint/openWorldHint annotations it discloses the validation pipeline (answers carry quotes checked against the source; pairs with non-matching quotes are dropped), a quality caveat (model-written, review before publishing), and the pricing model including that failed calls are not charged. That is exactly the extra context annotations cannot convey.

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?

Front-loaded with the core purpose and the quote-validation behavior, then routes to alternatives, then pricing. Every sentence carries information, though the pricing/network enumeration (USDC on Base, Solana and 10 more) is the least essential and adds length.

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?

An output schema exists so return shape needn't be explained, and annotations cover the safety profile. Combined with the disclosed filtering/drop behavior and billing terms, an agent has everything needed to call it correctly and interpret results.

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%, so both parameters are already documented. The description restates the 15-pair and 30,000-character limits rather than adding meaning such as how count interacts with text length or what happens at the cap; baseline 3 applies.

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 (generate up to 15 Q&A pairs from a text) with the character cap, and explicitly names the sibling tools it is not: text_chunk for overlapping chunks and text_headlines for headlines. An agent can tell this apart without opening any schema.

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?

It names the alternatives and the conditions that select them ('text_chunk when you need...', 'text_headlines when you need...'), which is explicit routing away from this tool. What it does not state is when this tool is the right choice versus other generation siblings such as text_answer or text_outline, so the guidance is clear but not exhaustive.

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