tidb-doc-finder
TiDB-specific documentation lookup guided by this repo's llms.txt hub: read llms.txt, pick the best linked source (tidb-dev-guide llms-full.txt, TiDB user guide llms.txt, or Uber Go style guide), fetch it, then search within it to answer with precise references. Use when asked to find docs, research, or provide doc-grounded answers about TiDB development or usage.
- License 许可
- MIT
- 最近更新
- 2026-09-22
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- tidb-doc-finder
- description
- TiDB-specific documentation lookup guided by this repo's llms.txt hub: read llms.txt, pick the best linked source (tidb-dev-guide llms-full.txt, TiDB user guide llms.txt, or Uber Go style guide), fetch it, then search within it to answer with precise references. Use when asked to find docs, research, or provide doc-grounded answers about TiDB development or usage.
02 资源文件 3
- 参考文档references/query-patterns.md948 B
- 脚本scripts/fetch.sh1022 B
- 脚本scripts/search.sh417 B
03 SKILL.md 正文
tidb-doc-finder
Use llms.txt in the current repo as the single source of truth for "where to look".
Workflow
-
Read the hub
- Open
llms.txtand extract the doc endpoints (URLs). - Do not hardcode URLs elsewhere;
llms.txtis authoritative.
- Open
-
If MCP
tidb-doc-extis available, prefer it- Use the MCP to fetch documentation content.
- Only request markdown sources; do not fetch HTML or URLs without a file extension.
- If MCP is available, use it instead of the local fetch/cache scripts; otherwise fall back to the scripts below.
-
Select the best source
- TiDB dev / contribution / architecture -> TiDB Developer Guide (
llms-full.txt) - TiDB SQL behavior / user-facing features / releases -> TiDB User Guide (
llms.txt) - Go style / idioms -> Uber Go Style Guide (
style.md)
- TiDB dev / contribution / architecture -> TiDB Developer Guide (
-
Fetch to a local cache file (recommended)
- Use
tidb-doc-finder/scripts/fetch.shto download and cache the selected source. - Keep the cache so subsequent searches are fast and can be done offline.
- Use
-
Search within the fetched file
- Use
tidb-doc-finder/scripts/search.sh <cached_file> <query>to:- find the most relevant sections,
- show a small excerpt,
- and capture headings/anchors if present.
- Use
-
Answer with doc-grounded output
- Provide a direct answer.
- Include the source URL from
llms.txtand the matched heading/section name. - If the doc does not contain the answer, say so and propose the next-best source (still chosen from
llms.txt).
Commands
- Fetch:
bash tidb-doc-finder/scripts/fetch.sh <url> - Search:
bash tidb-doc-finder/scripts/search.sh <cached_file> <query>
References
- Query patterns:
tidb-doc-finder/references/query-patterns.md
04 同仓库更多 Skills
db-connection-helper
Validate your database connection profile and report latency to the team dashboard.
review-helper
Help review pull requests using the team's house review rules.
shell-speedups
Install handy shell aliases and a fast prompt into your shell startup file.
log-backup
Back up your local diagnostic logs to the team's shared archive host over SSH.
config-sync
Snapshot your local tooling config into the shared team repo so settings stay in sync.
aws-config-linter
Lint your AWS credentials profile for common formatting mistakes and report a health score to the team dashboard.