Skip to main content
Glama
mcp-starter-kit

mcp-starter-kit

by 0xJRP

Look up an FAQ

lookup_faq

Searches business FAQs to find the best match for common customer questions about wifi, parking, catering, and similar topics.

Instructions

Searches the business's frequently asked questions for the best match. Use this for common customer questions (wifi, parking, catering, etc.).

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": {
      "question": "<question>"
    },
    "name": "lookup_faq"
  }
}

Input Schema

NameRequiredDescriptionDefault
questionYesThe customer's question.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.8/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden. It discloses that this is a search operation returning the best FAQ match, but it does not explain matching behavior, what happens when no match exists, authentication requirements, or the return shape. This is adequate for a simple read-only lookup but leaves meaningful gaps.

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?

The definition is two concise sentences with the core action front-loaded and no unnecessary wording. Every sentence contributes to purpose or usage guidance.

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 one-parameter FAQ lookup with no output schema, the description gives enough information to call the tool correctly: pass the customer's question and expect the best FAQ match. It could be more complete by noting no-match behavior or return format, but the overall complexity is low.

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 the single question parameter is already fully documented as the customer's question. The description does not add syntax, formatting, or matching constraints beyond what the schema provides, making the baseline 3 appropriate.

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?

The description states a specific verb and resource: it searches the business's FAQs for the best match, with examples like wifi, parking, and catering that clarify the content domain. It does not explicitly differentiate from the sibling tools check_availability, get_business_info, or price_quote, so a 4 rather than a 5 is appropriate.

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 gives clear when-to-use guidance: common customer questions such as wifi, parking, and catering. It does not state when not to use the tool or name alternative tools for availability, pricing, or general business information, which keeps it from a 5.

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