keytao-docs

Searches Keytao input method documentation via GitHub Code Search API and returns cleaned markdown content.

2|Updated Feb 16, 2026
One-click install
npx skills add https://github.com/xkinput/keytao-bot --skill keytao-docs-xkinput
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: keytao-docs
Source: https://github.com/xkinput/keytao-bot/tree/main/keytao_bot/skills/keytao-docs
Command: npx skills add https://github.com/xkinput/keytao-bot --skill keytao-docs-xkinput

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires httpx, nonebot.

What problem does it solve? Users asking conceptual questions about the Keytao input method (encoding rules, learning methods, installation, Lua features) need accurate answers sourced from official documentation rather than hallucinated responses. This Skill retrieves real documentation content from the official GitHub repository so the AI can answer with verified information and correct source links. ## Core Features & Use Cases - Full-Text Documentation Search: Uses the GitHub Code Search API against the xkinput/keytao-docs repository, with a fallback that matches query words against repository file paths when search fails. - Cleaned Content Delivery: Fetches raw markdown, strips frontmatter, truncates overly long content, and returns up to three relevant document fragments with source URLs. - Use Case: A user asks "键道的顶功规则是什么?" The AI calls keytao_fetch_docs with the query, receives the official rule documentation plus a source link, and presents the answer with the exact URL from the sources field. ## Quick Start Ask the bot a conceptual question about the Keytao input method, such as how to install it or what the encoding rules are, and it will search the official docs and reply with the content and source link.

Frequently Asked Questions about keytao-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I search GitHub repository documentation from a chatbot?▼

Use the GitHub Code Search API with a query scoped to the target repository and file extension, then fetch matching raw markdown files. This Skill queries repo:xkinput/keytao-docs for .md files and returns cleaned content with source URLs.

What tool answers Keytao input method usage questions?▼

The keytao_fetch_docs function answers conceptual questions about Keytao, including encoding rules, learning methods, installation, and Lua features like date input and single-character mode. For looking up specific word codes, a separate lookup tool is used instead.

Does GitHub Code Search API require authentication?▼

Authentication is optional but recommended. This Skill reads a GITHUB_TOKEN environment variable and adds a Bearer token header when present; without it, requests still work but face stricter rate limits, and a filename-matching fallback handles failures.

What happens when GitHub code search returns no results?▼

The Skill falls back to listing all markdown files via the GitHub Contents API and scores paths by matching query words against filenames. If nothing matches, it defaults to the guide/index.md page so the user still receives useful documentation.

Why must the bot not modify source URLs in responses?▼

The Skill instructions forbid guessing or altering URLs because documentation paths cannot be reliably inferred from titles. Only URLs returned in the sources field may be shown, preventing fabricated links to nonexistent pages.