Skip to main content
Glama

StruXure NorCal Knowledge Base

faq

Answer a question from this knowledge base's FAQ content. Returns the closest-matching FAQ passages, not extracted answers — for a customer reporting that something is broken, troubleshoot returns the resolution itself.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topKNoMaximum number of results to return (1–20).
queryYesThe question to answer from the FAQ.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

No annotations are provided, so the description must carry the burden. It clearly discloses that it returns matching passages, not extracted answers, which is a key behavioral trait. It also implies the tool is read-only (answering a question) and sets expectations about output compatibility. This goes beyond mere purpose to explain the nature of the response.

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 two sentences, concise and front-loaded with the primary purpose. It delivers the key distinction (returns passages, not answers) efficiently. No extraneous information. Slightly more could be added about typical use cases, but it is well-structured for its length.

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 retriever tool with no output schema, the description sufficiently explains what it returns (passages) and how it differs from a resolution provider. It lacks details on result format or ranking, but given the simplicity (2 params, no nested objects) and the clarity of operation, it is nearly complete. A minor gap is the absence of explicit search behavior (e.g., semantic search) or result ordering.

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 schema fully documents 'query' and 'topK'. The description does not add parameter-specific meaning beyond the schema, but it does clarify that 'query' is a natural language question and 'topK' controls result count. This is sufficient given the high schema coverage; the baseline of 3 is appropriate.

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 answers a question from FAQ content, specifies the action ('Answer a question') and the resource ('knowledge base's FAQ content'). It also distinguishes itself from the sibling 'troubleshoot' by noting the return type (passages vs. resolution), effectively differentiating it despite not naming 'troubleshoot' as a sibling in the given list.

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 implies when to use by contrasting with 'troubleshoot' for broken items, but does not explicitly state 'use when the answer is informational' or 'when not to use'. It gives a clear context but lacks explicit exclusions or alternative selection criteria beyond the one example.

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.

Resources