Yappy documentation MCP

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.

{
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "type": {
      "enum": [
        "doc",
        "faq"
      ],
      "type": "string",
      "description": "Narrow the search to documentation pages or FAQ entries."
    },
    "limit": {
      "type": "integer",
      "default": 5,
      "maximum": 20,
      "minimum": 1,
      "description": "How many results to return."
    },
    "query": {
      "type": "string",
      "maxLength": 200,
      "minLength": 2,
      "description": "What to search for, in plain words."
    }
  },
  "additionalProperties": false
}

{
  "title": "Search Yappy documentation",
  "readOnlyHint": true,
  "openWorldHint": true,
  "idempotentHint": true,
  "destructiveHint": false
}

Fetch one full Yappy documentation page as markdown, by slug. Use this after search_documentation when an excerpt is not enough and you need the whole page — for example the complete configuration reference or the full privacy model.

{
  "type": "object",
  "required": [
    "slug"
  ],
  "properties": {
    "slug": {
      "enum": [
        "quickstart",
        "dictation",
        "agent-mode",
        "backends",
        "configuration",
        "privacy-model",
        "troubleshooting",
        "changelog"
      ],
      "type": "string",
      "description": "Which page to fetch."
    }
  },
  "additionalProperties": false
}

{
  "title": "Read a Yappy documentation page",
  "readOnlyHint": true,
  "openWorldHint": true,
  "idempotentHint": true,
  "destructiveHint": false
}

List every page in the Yappy documentation with its slug, title, and one-line summary, so you can pick the right one to read instead of guessing a slug.

{
  "type": "object",
  "required": [],
  "properties": {
    "include_summaries": {
      "type": "boolean",
      "default": true,
      "description": "Include each page's one-line summary alongside its slug and title."
    }
  },
  "additionalProperties": false
}

{
  "title": "List Yappy documentation pages",
  "readOnlyHint": true,
  "openWorldHint": true,
  "idempotentHint": true,
  "destructiveHint": false
}

Advertised by the server during the last successful anonymous check.

Every Yappy documentation page with its slug, title, and summary.

yappy://docs/index

MIME type: text/markdown

Advertised by the server during the last successful anonymous check.

Download Yappy, grant the two macOS permissions it needs, and dictate your first sentence in about two minutes.

yappy://docs/quickstart

MIME type: text/markdown

Advertised by the server during the last successful anonymous check.

How the Right Option key works: on-device transcription, AI cleanup, smart spacing, hands-free mode, and personas.

yappy://docs/dictation

MIME type: text/markdown

Advertised by the server during the last successful anonymous check.

The Right Command key: Yappy reads your screen, acts in your apps, and hands control back before anything irreversible.

yappy://docs/agent-mode

MIME type: text/markdown

Advertised by the server during the last successful anonymous check.

Every cleanup backend Yappy supports — local Ollama, your Claude or xAI subscription, your own API key, or the hosted plan.

yappy://docs/backends

MIME type: text/markdown

Advertised by the server during the last successful anonymous check.

Every setting in ~/.yappy/config.json and what each one changes.

yappy://docs/configuration

MIME type: text/markdown

Advertised by the server during the last successful anonymous check.

A component-by-component account of what Yappy sends over the network and what never leaves your Mac.

yappy://docs/privacy-model

MIME type: text/markdown

Advertised by the server during the last successful anonymous check.

Fixes for a dead hotkey, silent dictation, a dropped Accessibility grant, and Agent Mode not starting.

yappy://docs/troubleshooting

MIME type: text/markdown

Advertised by the server during the last successful anonymous check.

Yappy release history for macOS, newest first.

yappy://docs/changelog

MIME type: text/markdown

Advertised by the server during the last successful anonymous check.

Any documentation page by slug — quickstart, dictation, agent-mode, backends, configuration, privacy-model, troubleshooting, changelog.

yappy://docs/{slug}

MIME type: text/markdown