Overview

MAGS Docs Search enables full-text search across all project documents. It parses your query, calls mags_search_docs, and returns results ranked by relevance to help you quickly locate architecture, rules, and reference docs.

How This Skill Works

You input a query via /mags-docs-search. The skill parses the argument, calls mags_search_docs with the query string, and then displays results ranked by relevance with excerpts to provide context.

When to Use It

• When you need to locate information scattered across docs, such as an architecture overview in docs/architecture/overview.md.
• When researching specific rules or guidelines found in docs/rules/backend.md.
• When you want to compare how a concept is described across multiple documents.
• When starting a task and needing quick references from the documentation.
• When you want to surface all mentions of a term across the project docs.

Quick Start

1. Step 1: /mags-docs-search <query>
2. Step 2: The skill parses the query and calls mags_search_docs with it.
3. Step 3: Results are displayed ranked by relevance with matching excerpts.

Best Practices

• Use precise keywords or phrases to narrow results.
• If searching for a multi-word phrase, enclose it in quotes to improve accuracy.
• If results are broad, try additional keywords or synonyms.
• skim the excerpted context to quickly verify relevance before opening the document.
• If no results appear, broaden terms or use /mags-docs to browse nearby docs.

Example Use Cases

• Find the architecture overview in docs/architecture/overview.md.
• Locate the backend rules in docs/rules/backend.md.
• Pull matching excerpts to compare how a term is described across docs.
• Identify API references across docs for integration tasks.
• Surface related docs when planning a new feature.

Frequently Asked Questions