Skip to main content
Glama

Al Jazeera 360

generate_faq_schema

Read-only

Generate FAQ Schema (JSON-LD) for a video to improve AI discoverability.

Creates structured FAQ data based on video title and description.
FAQ Schema helps content appear in AI answers (ChatGPT, Gemini, Perplexity)
and Google's People Also Ask section.

Args:
    video_id: The video ID to generate FAQ schema for

Returns:
    JSON with FAQ questions/answers and ready-to-use JSON-LD schema

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
video_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

The description discloses that FAQ data is created based on the video title and description and that the return value includes FAQ questions/answers plus JSON-LD schema. Since readOnlyHint=true already signals no side effects, this adds useful behavioral context without contradicting annotations.

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 description is well-structured with a clear purpose statement, benefit context, and Args/Returns sections. It is slightly verbose for a single-parameter tool, but each part earns its place and the key action is front-loaded.

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 simple one-parameter, read-only generation tool with an output schema present, the description is adequately complete. It covers what the tool does, what inputs it needs, and what it returns, leaving no critical gaps for correct invocation.

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?

The description provides a basic explanation for video_id ('The video ID to generate FAQ schema for'), but this largely restates the parameter name and type. With 0% schema description coverage, the description does not fully compensate by explaining where to find the ID or any expected format.

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?

The description clearly states the tool generates FAQ Schema (JSON-LD) for a video, naming the specific deliverable and purpose. It distinguishes itself from sibling tools like generate_series_schema by focusing on video-specific FAQ data and AI discoverability.

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

Usage Guidelines2/5

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

The description explains the benefit ('helps content appear in AI answers...') but gives no explicit guidance about when to use this tool versus alternatives like generate_series_schema or generate_sitemap, and no exclusion criteria. Usage context is only implied.

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.