Skip to main content
Glama
Ganjoor MCP Server

Ganjoor MCP Server

Official
by ganjoor

Get Ganjoor FAQ Item

ganjoor_get_faq_item
Read-onlyIdempotent

Retrieves a single published Ganjoor FAQ entry by its numeric ID and returns the question, answer, category, and pinned status in Markdown or JSON.

Instructions

Get one Ganjoor FAQ entry by its numeric id.

Args:

  • faq_id (number): FAQ item id (from ganjoor_get_faq_items)

  • response_format ('markdown' | 'json'): Output format (default: 'markdown')

Returns: For JSON: { id, category_id, question, answer, answer_excerpt, pinned }

Examples:

  • "Show FAQ item 7" -> faq_id=7

Notes:

  • Despite its name, answerExcerpt carries the complete body; fullAnswer is always empty upstream.

  • Only published items are served. An upstream 500 usually means the id does not exist — re-check the id from ganjoor_get_faq_items.

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": {
      "faq_id": "<faq_id>"
    },
    "name": "ganjoor_get_faq_item"
  }
}

Input Schema

NameRequiredDescriptionDefault
faq_idYesNumeric FAQ item id.
response_formatNoOutput format: 'markdown' for human-readable text (default) or 'json' for machine-readable structured data.markdown

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already declare readOnly, idempotent, non-destructive behavior, and the description adds genuinely non-obvious context: only published items are served, and an upstream 500 typically signals a nonexistent id rather than a transient failure. The note that answerExcerpt actually carries the complete body while fullAnswer is always empty upstream prevents a real misreading of the payload.

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 one-line purpose, then Args/Returns/Examples/Notes sections that let an agent skim to what it needs. The Args block is somewhat redundant against a 100%-covered schema, but it is short and the Notes section clearly earns its space.

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?

With no output schema, the Returns block supplies the field list ({id, category_id, question, answer, answer_excerpt, pinned}), and the Notes resolve the one confusing field-name mismatch. For a two-parameter read-only getter this covers everything an agent needs to call it and interpret the result.

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 parameters are already fully documented with types, enum values, and a default. The description restates them and adds only the example mapping ('Show FAQ item 7' -> faq_id=7), so the baseline of 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 ('Get one Ganjoor FAQ entry by its numeric id') and implicitly distinguishes itself from the plural sibling by naming ganjoor_get_faq_items as the source of ids. An agent can tell this single-item fetch apart from the list tool without opening either 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 tells the agent where the faq_id comes from (ganjoor_get_faq_items) and gives a concrete invocation example. It also supplies a recovery path when the call fails (an upstream 500 usually means the id does not exist, so re-check it). It does not spell out an explicit when-not condition, but for a single-item getter the routing is already unambiguous.

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