Context files help the agent generate more accurate, relevant, and high-quality suggestions tailored to your team’s needs.
Supported context file formats
The AI agent automatically recognizes and processes several standard context file formats when they’re placed in the root directory of your main branch:| File Name | Purpose |
|---|---|
agents.md | General-purpose context file for AI coding assistants (learn more about the agents.md standard) |
qodo.md | Context specific to Qodo-based AI tools |
claude.md | Context optimized for Claude AI integration |
What to Include in Context Files
Context files can contain various types of information to guide the AI agent:Architecture and design patterns
- Overview of your system architecture
- Design patterns and principles your team follows
- Key technical decisions and their rationale
Coding standards
- Language-specific style guidelines
- Naming conventions for variables, functions, and classes
- Code organization preferences
Development workflow
- Testing requirements and strategies
- Code review expectations
- Deployment considerations
Project-specific information
- Domain knowledge and business logic
- Common patterns used across the codebase
- Dependencies and their purposes
- Known limitations or technical debt
Best practices
- Keep It Concise
- Update Regularly
- Use Clear Language
- Prioritize Impact
Focus on key information impacting code suggestions. Avoid redundant details.
Get started
Enable context files
Before adding context files, you need to enable this feature in your Qodo configuration file:Configure custom context file names
You can also specify custom file names for your context files using the configuration:Info: Learn more about the Qodo Merge configuration file in the configuration Documentation.
Add a context file to your repository
Follow these steps to add a context file to your repository:Create one of the supported context files (
agents.md, qodo.md, or claude.md) in your repository’s root directoryBy investing time in creating comprehensive context files, you’ll see immediate improvements in the quality and relevance of AI-generated code suggestions.