{
  "schemaVersion": "1.0",
  "item": {
    "slug": "md-docs-search",
    "name": "Markdown Docs Full-Text Search",
    "source": "tencent",
    "type": "skill",
    "category": "效率提升",
    "sourceUrl": "https://clawhub.ai/carev01/md-docs-search",
    "canonicalUrl": "https://clawhub.ai/carev01/md-docs-search",
    "targetPlatform": "OpenClaw"
  },
  "install": {
    "downloadMode": "redirect",
    "downloadUrl": "/downloads/md-docs-search",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=md-docs-search",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "installMethod": "Manual import",
    "extraction": "Extract archive",
    "prerequisites": [
      "OpenClaw"
    ],
    "packageFormat": "ZIP package",
    "includedAssets": [
      "SKILL.md",
      "_meta.json",
      "references/search-patterns.md",
      "scripts/docs.py",
      "scripts/fts_search.py",
      "scripts/get_article.py"
    ],
    "primaryDoc": "SKILL.md",
    "quickSetup": [
      "Download the package from Yavira.",
      "Extract the archive and review SKILL.md first.",
      "Import or place the package into your OpenClaw setup."
    ],
    "agentAssist": {
      "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.",
      "steps": [
        "Download the package from Yavira.",
        "Extract it into a folder your agent can access.",
        "Paste one of the prompts below and point your agent at the extracted folder."
      ],
      "prompts": [
        {
          "label": "New install",
          "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete."
        },
        {
          "label": "Upgrade existing",
          "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run."
        }
      ]
    },
    "sourceHealth": {
      "source": "tencent",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-04-23T16:43:11.935Z",
      "expiresAt": "2026-04-30T16:43:11.935Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=4claw-imageboard",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=4claw-imageboard",
        "contentDisposition": "attachment; filename=\"4claw-imageboard-1.0.1.zip\"",
        "redirectLocation": null,
        "bodySnippet": null
      },
      "scope": "source",
      "summary": "Source download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this source.",
      "primaryActionLabel": "Download for OpenClaw",
      "primaryActionHref": "/downloads/md-docs-search"
    },
    "validation": {
      "installChecklist": [
        "Use the Yavira download entry.",
        "Review SKILL.md after the package is downloaded.",
        "Confirm the extracted package contains the expected setup assets."
      ],
      "postInstallChecks": [
        "Confirm the extracted package includes the expected docs or setup files.",
        "Validate the skill or prompts are available in your target agent workspace.",
        "Capture any manual follow-up steps the agent could not complete."
      ]
    },
    "downloadPageUrl": "https://openagent3.xyz/downloads/md-docs-search",
    "agentPageUrl": "https://openagent3.xyz/skills/md-docs-search/agent",
    "manifestUrl": "https://openagent3.xyz/skills/md-docs-search/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/md-docs-search/agent.md"
  },
  "agentAssist": {
    "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.",
    "steps": [
      "Download the package from Yavira.",
      "Extract it into a folder your agent can access.",
      "Paste one of the prompts below and point your agent at the extracted folder."
    ],
    "prompts": [
      {
        "label": "New install",
        "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete."
      },
      {
        "label": "Upgrade existing",
        "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run."
      }
    ]
  },
  "documentation": {
    "source": "clawhub",
    "primaryDoc": "SKILL.md",
    "sections": [
      {
        "title": "Markdown Documentation Full-Text Search",
        "body": "Fast, indexed full-text search across Markdown documentation archives using SQLite FTS5 with BM25 relevance ranking."
      },
      {
        "title": "When to Use",
        "body": "Searching documentation archives for specific features, capabilities, or information\nFinding official source URLs to cite in reports\nLooking up technical specifications or configuration details\nResearch across multiple documentation sources"
      },
      {
        "title": "Document Format Expected",
        "body": "Articles separated by --- delimiter with *Source: URL:\n\n# Article Title\n\n*Source: https://docs.example.com/path/to/article.html*\n\nArticle content here...\n\n---\n\n# Next Article Title\n\n*Source: https://docs.example.com/another/article.html*\n\nMore content..."
      },
      {
        "title": "Quick Start",
        "body": "# 1. Index the documentation (one-time or when docs change)\nscripts/docs.py index ./docs\n\n# 2. Search\nscripts/docs.py search \"kubernetes backup\" --max 5\n\n# 3. Check index status\nscripts/docs.py status"
      },
      {
        "title": "Primary Tool: docs.py",
        "body": "The unified CLI handles all operations:"
      },
      {
        "title": "Indexing",
        "body": "# Index documentation directory\nscripts/docs.py index ./docs\n\n# Force full rebuild\nscripts/docs.py index ./docs --rebuild\n\n# Custom database location\nscripts/docs.py index ./docs --db /path/to/custom.db"
      },
      {
        "title": "Searching",
        "body": "# Basic search\nscripts/docs.py search \"kubernetes backup\"\n\n# Boolean operators\nscripts/docs.py search \"AWS AND S3 AND snapshot\"\n\n# Phrase search\nscripts/docs.py search '\"exact phrase match\"'\n\n# Prefix search\nscripts/docs.py search \"kube*\"\n\n# Exclude terms\nscripts/docs.py search \"backup NOT restore\"\n\n# Title-only search\nscripts/docs.py search \"kubernetes\" --title-only\n\n# Output formats\nscripts/docs.py search \"kubernetes\" --format json\nscripts/docs.py search \"kubernetes\" --format markdown\n\n# More context around matches\nscripts/docs.py search \"kubernetes\" --context 400\n\n# Include full content in JSON\nscripts/docs.py search \"kubernetes\" --format json --full-content"
      },
      {
        "title": "FTS5 Query Syntax",
        "body": "SyntaxMeaningterm1 term2Documents with term1 OR term2 (ranked)term1 AND term2Documents with both termsterm1 OR term2Documents with either term\"exact phrase\"Exact phrase matchprefix*Words starting with prefixterm1 NOT term2term1 without term2title:termSearch only titles"
      },
      {
        "title": "Getting Specific Articles",
        "body": "# Get article by partial URL or title\nscripts/docs.py get \"system_requirements\" --full\n\n# Find all matching articles\nscripts/docs.py get \"backup\" --all"
      },
      {
        "title": "Status",
        "body": "# Check index statistics\nscripts/docs.py status"
      },
      {
        "title": "Discovery Phase",
        "body": "# Check what's indexed\nscripts/docs.py status\n\n# Explore topics with broad searches\nscripts/docs.py search \"<feature>\" --max 20"
      },
      {
        "title": "Research Phase",
        "body": "# Narrow down with boolean operators\nscripts/docs.py search \"<feature> AND <platform>\"\n\n# Find specific information\nscripts/docs.py search \"limitation OR restriction OR 'not supported'\""
      },
      {
        "title": "Citation Phase",
        "body": "Every search result includes the Source: URL — use this in your reports:\n\nAccording to documentation, [finding]...\n\nSource: https://docs.example.com/path/to/article.html"
      },
      {
        "title": "Multi-Source Setup",
        "body": "Each agent or project can have their own documentation and index:\n\n~/docs/VendorA/\n    ├── docs_part_01.md\n    ├── docs.db      # Index lives with docs\n    └── ...\n\n~/docs/VendorB/\n    ├── docs.md\n    ├── docs.db\n    └── ...\n\nThe docs.py script auto-detects the database location."
      },
      {
        "title": "Advanced Scripts",
        "body": "For specialized needs:\n\nscripts/fts_search.py — Direct FTS5 search with more options\nscripts/index_docs.py — Standalone indexing\nscripts/list_sources.py — List all source URLs\nscripts/get_article.py — Direct article retrieval\nscripts/search_docs.py — Regex-based search (no index needed)"
      },
      {
        "title": "Research Patterns",
        "body": "For common search patterns (feature research, architecture, security, etc.), see references/search-patterns.md."
      },
      {
        "title": "Example Session",
        "body": "# What's available?\nscripts/docs.py status\n# Output: Files indexed: 37, Articles indexed: 32065\n\n# Find information\nscripts/docs.py search \"kubernetes backup\" --max 5\n\n# Narrow to specific platform\nscripts/docs.py search \"kubernetes AND AWS\" --max 5\n\n# Find limitations\nscripts/docs.py search \"limitation OR 'not supported'\"\n\n# Get full article for citation\nscripts/docs.py get \"system_requirements\" --full"
      },
      {
        "title": "Best Practices",
        "body": "Index once, search many times — FTS5 is fast because it's indexed\nUse boolean operators — AND, OR, NOT for precision\nPhrase search for exact terms — \"exact match\" with quotes\nAlways cite sources — Include Source: URLs in reports\nRebuild periodically — Re-index when documentation updates\nUse JSON for analysis — Pipe to jq or other tools for processing"
      }
    ],
    "body": "Markdown Documentation Full-Text Search\n\nFast, indexed full-text search across Markdown documentation archives using SQLite FTS5 with BM25 relevance ranking.\n\nWhen to Use\nSearching documentation archives for specific features, capabilities, or information\nFinding official source URLs to cite in reports\nLooking up technical specifications or configuration details\nResearch across multiple documentation sources\nDocument Format Expected\n\nArticles separated by --- delimiter with *Source: URL:\n\n# Article Title\n\n*Source: https://docs.example.com/path/to/article.html*\n\nArticle content here...\n\n---\n\n# Next Article Title\n\n*Source: https://docs.example.com/another/article.html*\n\nMore content...\n\nQuick Start\n# 1. Index the documentation (one-time or when docs change)\nscripts/docs.py index ./docs\n\n# 2. Search\nscripts/docs.py search \"kubernetes backup\" --max 5\n\n# 3. Check index status\nscripts/docs.py status\n\nPrimary Tool: docs.py\n\nThe unified CLI handles all operations:\n\nIndexing\n# Index documentation directory\nscripts/docs.py index ./docs\n\n# Force full rebuild\nscripts/docs.py index ./docs --rebuild\n\n# Custom database location\nscripts/docs.py index ./docs --db /path/to/custom.db\n\nSearching\n# Basic search\nscripts/docs.py search \"kubernetes backup\"\n\n# Boolean operators\nscripts/docs.py search \"AWS AND S3 AND snapshot\"\n\n# Phrase search\nscripts/docs.py search '\"exact phrase match\"'\n\n# Prefix search\nscripts/docs.py search \"kube*\"\n\n# Exclude terms\nscripts/docs.py search \"backup NOT restore\"\n\n# Title-only search\nscripts/docs.py search \"kubernetes\" --title-only\n\n# Output formats\nscripts/docs.py search \"kubernetes\" --format json\nscripts/docs.py search \"kubernetes\" --format markdown\n\n# More context around matches\nscripts/docs.py search \"kubernetes\" --context 400\n\n# Include full content in JSON\nscripts/docs.py search \"kubernetes\" --format json --full-content\n\nFTS5 Query Syntax\nSyntax\tMeaning\nterm1 term2\tDocuments with term1 OR term2 (ranked)\nterm1 AND term2\tDocuments with both terms\nterm1 OR term2\tDocuments with either term\n\"exact phrase\"\tExact phrase match\nprefix*\tWords starting with prefix\nterm1 NOT term2\tterm1 without term2\ntitle:term\tSearch only titles\nGetting Specific Articles\n# Get article by partial URL or title\nscripts/docs.py get \"system_requirements\" --full\n\n# Find all matching articles\nscripts/docs.py get \"backup\" --all\n\nStatus\n# Check index statistics\nscripts/docs.py status\n\nWorkflow for Research Tasks\nDiscovery Phase\n# Check what's indexed\nscripts/docs.py status\n\n# Explore topics with broad searches\nscripts/docs.py search \"<feature>\" --max 20\n\nResearch Phase\n# Narrow down with boolean operators\nscripts/docs.py search \"<feature> AND <platform>\"\n\n# Find specific information\nscripts/docs.py search \"limitation OR restriction OR 'not supported'\"\n\nCitation Phase\n\nEvery search result includes the Source: URL — use this in your reports:\n\nAccording to documentation, [finding]...\n\nSource: https://docs.example.com/path/to/article.html\n\nMulti-Source Setup\n\nEach agent or project can have their own documentation and index:\n\n~/docs/VendorA/\n    ├── docs_part_01.md\n    ├── docs.db      # Index lives with docs\n    └── ...\n\n~/docs/VendorB/\n    ├── docs.md\n    ├── docs.db\n    └── ...\n\n\nThe docs.py script auto-detects the database location.\n\nAdvanced Scripts\n\nFor specialized needs:\n\nscripts/fts_search.py — Direct FTS5 search with more options\nscripts/index_docs.py — Standalone indexing\nscripts/list_sources.py — List all source URLs\nscripts/get_article.py — Direct article retrieval\nscripts/search_docs.py — Regex-based search (no index needed)\nResearch Patterns\n\nFor common search patterns (feature research, architecture, security, etc.), see references/search-patterns.md.\n\nExample Session\n# What's available?\nscripts/docs.py status\n# Output: Files indexed: 37, Articles indexed: 32065\n\n# Find information\nscripts/docs.py search \"kubernetes backup\" --max 5\n\n# Narrow to specific platform\nscripts/docs.py search \"kubernetes AND AWS\" --max 5\n\n# Find limitations\nscripts/docs.py search \"limitation OR 'not supported'\"\n\n# Get full article for citation\nscripts/docs.py get \"system_requirements\" --full\n\nBest Practices\nIndex once, search many times — FTS5 is fast because it's indexed\nUse boolean operators — AND, OR, NOT for precision\nPhrase search for exact terms — \"exact match\" with quotes\nAlways cite sources — Include Source: URLs in reports\nRebuild periodically — Re-index when documentation updates\nUse JSON for analysis — Pipe to jq or other tools for processing"
  },
  "trust": {
    "sourceLabel": "tencent",
    "provenanceUrl": "https://clawhub.ai/carev01/md-docs-search",
    "publisherUrl": "https://clawhub.ai/carev01/md-docs-search",
    "owner": "carev01",
    "version": "1.0.2",
    "license": null,
    "verificationStatus": "Indexed source record"
  },
  "links": {
    "detailUrl": "https://openagent3.xyz/skills/md-docs-search",
    "downloadUrl": "https://openagent3.xyz/downloads/md-docs-search",
    "agentUrl": "https://openagent3.xyz/skills/md-docs-search/agent",
    "manifestUrl": "https://openagent3.xyz/skills/md-docs-search/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/md-docs-search/agent.md"
  }
}