Skip to main content
Glama

Yappy documentation

Search Yappy documentation

search_documentation
Read-onlyIdempotent

Full-text search across Yappy documentation and FAQ. Use this to answer how-to and troubleshooting questions: installing Yappy, granting macOS permissions, a hotkey that does nothing, choosing an LLM backend, configuration keys, personas, or exactly what stays on-device. Results carry an excerpt you can quote and a URL you can cite.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
typeNoNarrow the search to documentation pages or FAQ entries.
limitNoHow many results to return.
queryYesWhat to search for, in plain words.

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already mark the tool as read-only, idempotent, and non-destructive. The description adds useful behavioral context by noting that results include an excerpt and a URL, and by framing the search as covering both documentation and FAQ.

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 front-loaded with the core function, then gives focused use cases, then states the result format. The list of example topics is long but relevant and helps an agent form queries.

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?

Despite having no output schema, the description explains return value components (excerpt and URL). Together with the schema defining the three parameters, an agent has enough context to select and invoke the tool correctly. Minor gaps like handling no results are not critical here.

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 the baseline is 3. The description adds example query topics and mentions full-text search, but does not add significant semantics beyond what the schema already provides for `query`, `type`, and `limit`.

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?

Description states a specific verb ('search') and resource ('Yappy documentation and FAQ'), with full-text scope and concrete example topics. This clearly distinguishes it from siblings that get or list pages.

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?

Explicitly says to use the tool for how-to and troubleshooting questions and gives concrete examples such as installing Yappy and macOS permissions. It does not explicitly state when not to use it or name alternatives, but the context is clear.

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.

TDQS

A4.4/5.0
Disambiguation5/5

The three tools map cleanly to distinct actions: search finds relevant content, list gives an overview of all pages, and get fetches a specific page by slug. There is no meaningful overlap, and the descriptions even prescribe how the tools chain together.

Naming Consistency5/5

All tool names follow a consistent verb_noun snake_case pattern: search_documentation, list_documentation_pages, get_documentation_page. The slight variation between 'documentation' and 'documentation_pages' is natural since search also covers the FAQ.

Tool Count5/5

Three tools is an appropriate size for a documentation server focused on reading and searching. Each tool earns its place, and none is redundant.

Completeness5/5

For a documentation MCP server, this surface is complete: search handles how-to and troubleshooting, list supports discovery when no slug is known, and get provides the full page when excerpts are insufficient. There are no dead ends or obvious missing operations.

Resources