Skip to main content
Glama
RyanKramer

AutoRank MCP

by RyanKramer

generate_faq_schema

Generate FAQPage JSON-LD from Q&A content visible on your page, ensuring accurate structured data for search engines.

Instructions

Generate FAQPage JSON-LD. Each item needs 'question' and 'answer'.

The answers MUST already be visible on the page. Schema that disagrees with the rendered page is a spam signal, not a shortcut.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
questions_and_answersYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It explains a key constraint (page visibility and spam implications) but does not describe the tool's internal validation behavior, output format, or whether it performs any side effects. This is adequate but not rich.

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 short sentences, front-loaded with the main purpose. The first sentence states the primary function, and the second adds a crucial constraint. No filler or redundant repetition of schema details.

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 tool with an output schema, the description covers the core requirements and constraints. It could optionally mention the output format more explicitly, but 'Generate FAQPage JSON-LD' implies the output. The description is largely complete for its intended use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has zero description coverage, but the description explicitly states that each item in the questions_and_answers array needs 'question' and 'answer'. This adds critical meaning beyond the schema's generic 'additionalProperties: true' and effectively documents the required structure.

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's function: 'Generate FAQPage JSON-LD' – a specific verb and resource. It distinguishes itself from sibling tools like generate_article_schema and generate_breadcrumb_schema by naming the FAQPage schema type explicitly.

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 description provides a clear usage condition: answers must already be visible on the page. It also warns against using the tool as a shortcut when content isn't visible, framing it as a spam signal. However, it doesn't explicitly compare to sibling schema generators or mention when not to use it in favor of another tool.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/RyanKramer/autorank-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server