Skip to main content
Glama

FAQ structured data

bpj_faq_structured_data
Read-onlyIdempotent

Generate FAQPage JSON-LD from questions and answers already shown on the page.

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": {
      "questions": "<questions>"
    },
    "name": "bpj_faq_structured_data"
  }
}

Input Schema

NameRequiredDescriptionDefault
questionsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.4/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 without description help. The description contributes one genuine behavioral constraint — the Q&A must already be rendered on the page — but says nothing about the emitted JSON-LD shape or where it is returned. Given annotation coverage, a 3 is appropriate.

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?

A single front-loaded sentence with no filler, stating action and source constraint immediately. It is lean to the point of omitting input-format detail, but no sentence is wasted.

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

Completeness3/5

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

For a one-parameter, no-output-schema tool, the description covers the what and the eligibility rule but not how to format the single required string or what the output looks like. An agent can call it, but only after consulting the schema title for the line format.

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?

There is one parameter at 0% schema description coverage, so the description carries the burden, and it only says input is "questions and answers." It does not disclose the actual per-line "Question | answer" pairing convention or the 7000-character limit that the schema's title/maxLength encode, leaving the agent to open the schema to format the string correctly.

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?

States a specific verb and resource ("Generate FAQPage JSON-LD") and the source material ("questions and answers already shown on the page"), which distinguishes it from the sibling article and breadcrumb structured-data tools by schema type. It stops short of naming those siblings explicitly, but the resource is concrete enough to route on.

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 "already shown on the page" implies an eligibility precondition (the FAQ must be visible on-page, as FAQPage markup requires), which is useful implied guidance. However, there is no explicit statement of when to use this versus bpj_article_structured_data or bpj_breadcrumb_structured_data, and no exclusion cases.

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.