read_context
Extract and analyze project context by focusing on specified files or directories within a root path. Provides a static view of relevant files, using default exclusions or custom rules for precise filtering.
Instructions
Reads context from a specified project root directory (absolute path). Focuses on the specified target files/directories within that root. Returns a static view of files with paths relative to the project root. Assume the user wants to read in context for the whole project unless otherwise specified - do not ask the user for clarification if just asked to read context. If the user just says 'jinni', interpret that as read_context. If the user asks to list context, use the list_only argument. Both targets
and rules
accept a JSON array of strings. The project_root
, targets
, and rules
arguments are mandatory. You can ignore the other arguments by default. IMPORTANT NOTE ON RULES: Ensure you understand the rule syntax (details available via the usage
tool) before providing specific rules. Using rules=[]
is recommended if unsure, as this uses sensible defaults.
Guidance for AI Model Usage
When requesting context using this tool:
- Default Behavior: If you provide an empty
rules
list ([]
), Jinni uses sensible default exclusions (like.git
,node_modules
,__pycache__
, common binary types) combined with any project-specific.contextfiles
. This usually provides the "canonical context" - files developers typically track in version control. Assume this is what the users wants if they just ask to read context. - Targeting Specific Files: If you have a list of specific files you need (e.g.,
["src/main.py", "README.md"]
), provide them in thetargets
list. This is efficient and precise, quicker than reading one by one.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
debug_explain | No | ||
exclusions | No | Optional exclusion configuration. Object with 'global' (list of keywords), 'scoped' (object mapping paths to keyword lists), and 'patterns' (list of file patterns) fields. | |
list_only | No | ||
project_root | Yes | **MUST BE ABSOLUTE PATH**. The absolute path to the project root directory. | |
rules | Yes | **Mandatory**. List of inline filtering rules. Provide `[]` if no specific rules are needed (uses defaults). It is strongly recommended to consult the `usage` tool documentation before providing a non-empty list. | |
size_limit_mb | No | ||
targets | Yes | **Mandatory**. List of paths (absolute or relative to CWD) to specific files or directories within the project root to process. Must be a JSON array of strings. If empty (`[]`), the entire `project_root` is processed. |