doc_list

doc_list returns every document that has been indexed with doc_index, showing the doc_id, original path, and chunk count.

Usage

doc_list()

Output

Indexed documents (3):

  docs_ARCHITECTURE_md        docs/ARCHITECTURE.md         (24 chunks)
  abs_path_to_spec_yaml       /abs/path/to/spec.yaml       (41 chunks)
  data_csv                    data.csv                     (312 rows)

When to use

• Confirm a document was indexed before querying it
• Find the correct doc_id to use with doc_toc, doc_get, or doc_query
• Audit which documents are available in the current project context

Related workflow

doc_list()                                         → find the doc_id
doc_toc(doc_id="docs_ARCHITECTURE_md")             → see section headings
doc_get(doc_id="docs_ARCHITECTURE_md", section="Auth")  → read one section