mirror of
https://github.com/bahdotsh/wrkflw.git
synced 2026-05-18 05:05:35 +02:00
05ed4d12b4
Add CLAUDE.md, AGENTS.md, and INDEX.md — all generated by the indxr MCP tooling to give AI coding assistants a structured way to explore the codebase without dumping entire files into context. CLAUDE.md is the detailed version with token cost estimates and a full tool reference. AGENTS.md is the condensed version. INDEX.md is an auto-generated codebase index with file summaries and symbol maps. While at it, add .indxr-cache/ to .gitignore because nobody needs that in the repo.
1.2 KiB
1.2 KiB
Codebase Navigation — Use indxr MCP tools
An MCP server called indxr is available. Always use indxr tools before reading full files.
Exploration workflow
search_relevant— find files/symbols by concept or partial nameget_tree— see directory/file layoutget_file_summary/batch_file_summaries— understand files without reading themexplain_symbol— get signature, docs, and relationships for a symbolget_public_api— public API surface of a file or moduleget_callers/get_related_tests— find references and testsget_token_estimate— check cost before deciding to read a full fileread_source— read just one function/struct by name- Read (full file) — ONLY when editing or need exact formatting
When to read full files instead
- You need to edit a file
- You need exact formatting/whitespace
- The file is not source code (e.g., config files, documentation)
Do NOT
- Read full source files just to understand what's in them
- Dump all files into context
- Use
git diffwhenget_diff_summarywould suffice
After making code changes
Run regenerate_index to keep the index current.