Add AGENTS.md Support #465
Open
+518
−79
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit implements support for the AGENTS.md standard (https://agents.md/), allowing deepagents to automatically load project-specific configuration files that provide context and instructions to AI coding agents. ## Changes ### Core Implementation - **config.py**: Added _find_agents_md() function to discover AGENTS.md files hierarchically from current directory up to project root - **config.py**: Added Settings.get_agents_md_files() method for retrieving AGENTS.md file paths - **agent_memory.py**: Extended AgentMemoryMiddleware to load AGENTS.md files alongside existing user and project agent.md files - **agent_memory.py**: Added agents_md_memory to state schema and updated system prompt templates to include AGENTS.md content ### Features - Hierarchical file discovery: searches from current directory up to (but not including) project root - Monorepo support: nested AGENTS.md files provide subproject-specific context - Multiple file combination: all discovered AGENTS.md files are combined with clear separation markers - Automatic integration: no configuration needed, files are automatically loaded if present ### Testing - **test_config.py**: Added comprehensive tests for _find_agents_md() function - Single file discovery - Hierarchical discovery - Project root boundary behavior - Monorepo scenarios - **test_project_memory.py**: Added middleware integration tests - Single AGENTS.md file loading - Multiple hierarchical AGENTS.md files - Combined loading with user and project agent.md ### Documentation - **README.md**: Added detailed AGENTS.md support section explaining: - What AGENTS.md is and its benefits - How it works in deepagents - Example directory structure for monorepos - Sample AGENTS.md file content ## Compliance with AGENTS.md Specification - Follows hierarchical loading pattern (most specific to least specific) - Stops before project root as per spec - Supports monorepos with nested configuration files - Compatible with other AI coding agents using the same standard
The deepagents-cli was importing termios and tty modules unconditionally, which are Unix-only and not available on Windows. This caused import errors when trying to use the CLI or run tests on Windows platforms. ## Changes - Made termios and tty imports conditional with try-except - Added HAS_TERMIOS flag to check for module availability - Wrapped Unix-specific terminal control code in conditional blocks - Provided Windows fallback using standard input() for approval prompts - Existing fallback code now works correctly on Windows ## Testing - Verified imports work correctly on Windows - Confirmed AGENTS.md tests pass successfully on Windows platform - Terminal control features degrade gracefully on Windows This fix enables development and testing on Windows while maintaining full functionality on Unix platforms.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implements support for the AGENTS.md standard, enabling deepagents to automatically load standardized AI agent configuration files from projects.
🎯 Fixes
Closes #449
📝 Summary
This PR adds hierarchical AGENTS.md file discovery and loading to deepagents-cli, following the official agents.md specification. AGENTS.md files provide standardized project context, build steps, tests, and coding conventions that work across multiple AI coding agents (Cursor, Aider, GitHub Copilot, etc.).
🔧 Implementation Details
Core Changes
Configuration Discovery (
config.py)_find_agents_md()function for hierarchical file discoverySettings.get_agents_md_files()for easy accessMemory Integration (
agent_memory.py)AgentMemoryMiddlewareto load AGENTS.md filesagents_md_memoryto state schemaKey Features
✅ Hierarchical Loading: Files loaded from most specific (current dir) to least specific
✅ Monorepo Support: Nested AGENTS.md files provide subproject-specific context
✅ Zero Configuration: Automatic detection and loading
✅ Spec Compliant: Follows https://agents.md/ specification
Example Usage
When working in
packages/package-a/src/, both AGENTS.md files are automatically loaded and combined.🧪 Testing
Comprehensive Test Suite
Unit Tests (
test_config.py)Integration Tests (
test_project_memory.py)All tests passing ✓
Windows Compatibility Fix
execution.pymodule. The original code importedtermiosandttyunconditionally (Unix-only modules), causing import errors on Windows.Changes:
termios/ttyimports conditional with try-exceptHAS_TERMIOSflag for runtime checksinput()for approvalsTesting Request: If you're on Windows, please verify that:
📚 Documentation
🔄 Backward Compatibility
✅ Fully backward compatible - existing functionality unchanged
✅ AGENTS.md loading is optional and automatic
✅ Works alongside existing agent.md files