|
| 1 | +# Documentation Index |
| 2 | + |
| 3 | +Complete guide to coding-open-agent-tools documentation. |
| 4 | + |
| 5 | +## Quick Start |
| 6 | + |
| 7 | +- **[README.md](../README.md)** - Project overview, installation, quick start |
| 8 | +- **[docs/examples/](examples/)** - Practical usage examples with token savings analysis |
| 9 | + |
| 10 | +## Core Documentation |
| 11 | + |
| 12 | +### Architecture & Design |
| 13 | +- **[ARCHITECTURE.md](../ARCHITECTURE.md)** - Complete architecture overview |
| 14 | + - Project philosophy: Token efficiency first |
| 15 | + - Design patterns and best practices |
| 16 | + - Module organization |
| 17 | + - Framework compatibility (Strands, Google ADK, LangGraph) |
| 18 | + - Code quality standards |
| 19 | + - Testing strategy |
| 20 | + - Optional dependencies pattern |
| 21 | + - Performance considerations |
| 22 | + |
| 23 | +### Contributing |
| 24 | +- **[CONTRIBUTING.md](../CONTRIBUTING.md)** - Comprehensive contribution guide |
| 25 | + - Development setup |
| 26 | + - Code quality standards |
| 27 | + - Testing guidelines |
| 28 | + - What to contribute (and what not to) |
| 29 | + - Decision framework |
| 30 | + - Pull request process |
| 31 | + - Decorator requirements |
| 32 | + - Google ADK compliance rules |
| 33 | + |
| 34 | +### Security |
| 35 | +- **[SECURITY.md](../SECURITY.md)** - Security policy and reporting |
| 36 | +- **[CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md)** - Community guidelines |
| 37 | + |
| 38 | +## Usage Examples |
| 39 | + |
| 40 | +Located in [docs/examples/](examples/): |
| 41 | + |
| 42 | +### 1. Python Validation |
| 43 | +**File:** [01_python_validation.py](examples/01_python_validation.py) |
| 44 | +**Token Savings:** 90-95% |
| 45 | +**Focus:** Validate Python syntax before execution, prevent retry loops |
| 46 | + |
| 47 | +### 2. Git Health Check |
| 48 | +**File:** [02_git_health_check.py](examples/02_git_health_check.py) |
| 49 | +**Token Savings:** 70-85% |
| 50 | +**Focus:** Repository health monitoring, metrics, garbage collection |
| 51 | + |
| 52 | +### 3. Code Navigation |
| 53 | +**File:** [03_code_navigation.py](examples/03_code_navigation.py) |
| 54 | +**Token Savings:** 70-95% |
| 55 | +**Focus:** Navigate code without reading full files, function discovery |
| 56 | + |
| 57 | +### 4. Security Scanning |
| 58 | +**File:** [04_security_scanning.py](examples/04_security_scanning.py) |
| 59 | +**Token Savings:** 85-90% |
| 60 | +**Focus:** Detect secrets and security vulnerabilities |
| 61 | + |
| 62 | +### 5. Config Parsing |
| 63 | +**File:** [05_config_parsing.py](examples/05_config_parsing.py) |
| 64 | +**Token Savings:** 80-90% |
| 65 | +**Focus:** Parse and validate configuration files (YAML, TOML, JSON, .env) |
| 66 | + |
| 67 | +**Examples README:** [docs/examples/README.md](examples/README.md) |
| 68 | + |
| 69 | +## Planning & Roadmap |
| 70 | + |
| 71 | +- **[TODO.md](../TODO.md)** - Current roadmap and planned features |
| 72 | +- **[ROADMAP.md](ROADMAP.md)** - Long-term vision (36 modules, 370+ functions) |
| 73 | +- **[MODULE_SUMMARY.md](MODULE_SUMMARY.md)** - Complete module plan |
| 74 | +- **[CHANGELOG.md](../CHANGELOG.md)** - Release history and updates |
| 75 | + |
| 76 | +## Product Requirements |
| 77 | + |
| 78 | +Located in [docs/PRD/](PRD/): |
| 79 | + |
| 80 | +- **[01-project-overview.md](PRD/01-project-overview.md)** - Project vision and goals |
| 81 | +- **[02-shell-module-prd.md](PRD/02-shell-module-prd.md)** - Shell module specification |
| 82 | +- **[03-codegen-module-prd.md](PRD/03-codegen-module-prd.md)** - Code generation module (future) |
| 83 | + |
| 84 | +## Module Documentation |
| 85 | + |
| 86 | +### Core Modules (199 functions) |
| 87 | + |
| 88 | +#### Code Analysis |
| 89 | +- **Git Module** (79 functions) |
| 90 | + - 14 submodules: branches, commits, config, conflicts, diffs, health, history, hooks, remotes, security, status, submodules, tags, workflows |
| 91 | + - Repository operations and health checks |
| 92 | + - Security scanning and metrics |
| 93 | + |
| 94 | +- **Python Module** (32 functions) |
| 95 | + - 5 submodules: navigation, validators, analyzers, extractors, formatters |
| 96 | + - 17 navigation tools (70-95% token savings) |
| 97 | + - Syntax validation and type checking |
| 98 | + |
| 99 | +- **Analysis Module** (14 functions) |
| 100 | + - AST parsing and complexity calculation |
| 101 | + - Import tracking and management |
| 102 | + - Secret detection |
| 103 | + |
| 104 | +#### Configuration & Data |
| 105 | +- **Config Module** (28 functions) |
| 106 | + - .env file operations |
| 107 | + - YAML/TOML/JSON extraction |
| 108 | + - INI/properties/XML parsing |
| 109 | + - Security scanning |
| 110 | + |
| 111 | +- **Database Module** (18 functions) |
| 112 | + - SQLite operations |
| 113 | + - Safe query building |
| 114 | + - Schema inspection |
| 115 | + |
| 116 | +#### Development Tools |
| 117 | +- **Shell Module** (13 functions) |
| 118 | + - Shell validation and security |
| 119 | + - Argument escaping |
| 120 | + |
| 121 | +- **Profiling Module** (8 functions) |
| 122 | + - Performance and memory profiling |
| 123 | + |
| 124 | +- **Quality Module** (7 functions) |
| 125 | + - Static analysis parsers |
| 126 | + |
| 127 | +### Language-Specific Modules (87 functions) |
| 128 | + |
| 129 | +7 language modules with 17 functions each: |
| 130 | +- C++ navigation |
| 131 | +- C# navigation |
| 132 | +- Go navigation |
| 133 | +- Java navigation |
| 134 | +- JavaScript/TypeScript navigation |
| 135 | +- Ruby navigation |
| 136 | +- Rust navigation |
| 137 | + |
| 138 | +## Key Concepts |
| 139 | + |
| 140 | +### Token Efficiency Philosophy |
| 141 | + |
| 142 | +**We build what agents waste tokens on:** |
| 143 | +- ✅ Validators - Catch errors before execution |
| 144 | +- ✅ Parsers - Convert unstructured → structured |
| 145 | +- ✅ Extractors - Pull specific data |
| 146 | +- ✅ Formatters - Apply deterministic rules |
| 147 | +- ✅ Scanners - Rule-based detection |
| 148 | + |
| 149 | +**We avoid what agents do well:** |
| 150 | +- ❌ Code generators |
| 151 | +- ❌ Architecture tools |
| 152 | +- ❌ Refactoring tools |
| 153 | + |
| 154 | +### Design Patterns |
| 155 | + |
| 156 | +1. **Decorator Pattern** - Centralized `@strands_tool` decorator |
| 157 | +2. **Shared Utilities** - Common validation functions |
| 158 | +3. **JSON-Serializable Returns** - Google ADK compliance |
| 159 | +4. **Input Validation** - Clear error messages |
| 160 | +5. **Smart Confirmation** - Three-mode system (bypass/interactive/agent) |
| 161 | + |
| 162 | +### Framework Compatibility |
| 163 | + |
| 164 | +| Framework | Support | Notes | |
| 165 | +|-----------|---------|-------| |
| 166 | +| **Strands** | ✅ Full | All tools use `@strands_tool` decorator | |
| 167 | +| **Google ADK** | ✅ Full | JSON-serializable returns, no defaults | |
| 168 | +| **LangGraph** | ✅ Full | Works with standard callables | |
| 169 | + |
| 170 | +## Testing & Quality |
| 171 | + |
| 172 | +### Quality Standards |
| 173 | +- 100% ruff compliance |
| 174 | +- 100% mypy compliance |
| 175 | +- 83% test coverage (571 tests passing) |
| 176 | +- Google ADK compliance |
| 177 | + |
| 178 | +### Test Categories |
| 179 | +1. Type validation tests |
| 180 | +2. Value validation tests |
| 181 | +3. Path validation tests |
| 182 | +4. Happy path tests |
| 183 | +5. Edge case tests |
| 184 | +6. Mocked subprocess tests |
| 185 | + |
| 186 | +### Running Tests |
| 187 | +```bash |
| 188 | +# All tests |
| 189 | +pytest tests/ |
| 190 | + |
| 191 | +# With coverage |
| 192 | +pytest tests/ --cov=src --cov-report=term |
| 193 | + |
| 194 | +# Specific module |
| 195 | +pytest tests/git/test_health.py -v |
| 196 | +``` |
| 197 | + |
| 198 | +## Helper Functions |
| 199 | + |
| 200 | +11 helper functions for tool management: |
| 201 | + |
| 202 | +### Tool Loading |
| 203 | +- `load_all_tools()` - Load all 286 functions |
| 204 | +- `load_all_analysis_tools()` - 14 functions |
| 205 | +- `load_all_config_tools()` - 28 functions |
| 206 | +- `load_all_git_tools()` - 79 functions |
| 207 | +- `load_all_profiling_tools()` - 8 functions |
| 208 | +- `load_all_quality_tools()` - 7 functions |
| 209 | +- `load_all_shell_tools()` - 13 functions |
| 210 | +- `load_all_python_tools()` - 32 functions |
| 211 | +- `load_all_database_tools()` - 18 functions |
| 212 | + |
| 213 | +### Tool Management |
| 214 | +- `merge_tool_lists()` - Combine tool lists |
| 215 | +- `get_tool_info()` - Inspect tool details |
| 216 | +- `list_all_available_tools()` - Get organized catalog |
| 217 | + |
| 218 | +## Installation |
| 219 | + |
| 220 | +### Basic Installation |
| 221 | +```bash |
| 222 | +pip install coding-open-agent-tools |
| 223 | +``` |
| 224 | + |
| 225 | +### Optional Dependencies |
| 226 | +```bash |
| 227 | +# Enhanced security scanning |
| 228 | +pip install coding-open-agent-tools[enhanced-security] |
| 229 | + |
| 230 | +# Enhanced navigation |
| 231 | +pip install coding-open-agent-tools[enhanced-navigation] |
| 232 | + |
| 233 | +# All optional features |
| 234 | +pip install coding-open-agent-tools[all] |
| 235 | + |
| 236 | +# Development installation |
| 237 | +pip install -e ".[dev]" |
| 238 | +``` |
| 239 | + |
| 240 | +## Quick Reference |
| 241 | + |
| 242 | +### Token Savings by Use Case |
| 243 | + |
| 244 | +| Use Case | Without Tools | With Tools | Savings | |
| 245 | +|----------|--------------|------------|---------| |
| 246 | +| Python validation | 1700 tokens | 950 tokens | 44% | |
| 247 | +| Git health check | 1000 tokens | 200 tokens | 80% | |
| 248 | +| Code navigation | 1700 tokens | 180 tokens | 89% | |
| 249 | +| Security scanning | 8500 tokens | 600 tokens | 93% | |
| 250 | +| Config parsing | 1000 tokens | 80 tokens | 92% | |
| 251 | + |
| 252 | +**Average: 80-90% token savings** |
| 253 | + |
| 254 | +### Common Workflows |
| 255 | + |
| 256 | +#### 1. Validate Generated Code |
| 257 | +```python |
| 258 | +from coding_open_agent_tools.python import validators |
| 259 | + |
| 260 | +result = validators.validate_python_syntax(generated_code) |
| 261 | +if result['is_valid'] == 'true': |
| 262 | + # Code is valid, proceed |
| 263 | + pass |
| 264 | +``` |
| 265 | + |
| 266 | +#### 2. Navigate Codebase |
| 267 | +```python |
| 268 | +from coding_open_agent_tools.python import navigation |
| 269 | + |
| 270 | +# Get overview |
| 271 | +overview = navigation.get_python_module_overview(source_code) |
| 272 | + |
| 273 | +# Get line numbers for specific function |
| 274 | +lines = navigation.get_python_function_line_numbers(source_code, "my_function") |
| 275 | +# Use with Read tool for targeted reading |
| 276 | +``` |
| 277 | + |
| 278 | +#### 3. Check Repository Health |
| 279 | +```python |
| 280 | +from coding_open_agent_tools.git import health |
| 281 | + |
| 282 | +metrics = health.get_repository_metrics(repo_path) |
| 283 | +print(f"Health score: {metrics['health_score']}/100") |
| 284 | +``` |
| 285 | + |
| 286 | +#### 4. Scan for Secrets |
| 287 | +```python |
| 288 | +from coding_open_agent_tools.analysis import secrets |
| 289 | + |
| 290 | +result = secrets.scan_for_secrets(code_content) |
| 291 | +if result['secret_count'] != '0': |
| 292 | + # Handle found secrets |
| 293 | + pass |
| 294 | +``` |
| 295 | + |
| 296 | +#### 5. Parse Configuration |
| 297 | +```python |
| 298 | +from coding_open_agent_tools.config import extractors |
| 299 | + |
| 300 | +db_host = extractors.extract_yaml_value(config_content, "database.host") |
| 301 | +print(f"Database host: {db_host['value']}") |
| 302 | +``` |
| 303 | + |
| 304 | +## Additional Resources |
| 305 | + |
| 306 | +### External Links |
| 307 | +- [GitHub Repository](https://github.com/Open-Agent-Tools/coding-open-agent-tools) |
| 308 | +- [PyPI Package](https://pypi.org/project/coding-open-agent-tools/) |
| 309 | +- [basic-open-agent-tools](https://github.com/Open-Agent-Tools/basic-open-agent-tools) - Foundation layer |
| 310 | +- [Open Agent Tools Organization](https://github.com/Open-Agent-Tools) |
| 311 | + |
| 312 | +### Community |
| 313 | +- GitHub Issues - Bug reports and feature requests |
| 314 | +- GitHub Discussions - Questions and ideas |
| 315 | +- Pull Requests - Contributions welcome |
| 316 | + |
| 317 | +## Version Information |
| 318 | + |
| 319 | +**Current Version:** v0.9.1 |
| 320 | +**Status:** Active Development |
| 321 | +**Python Support:** 3.9+ |
| 322 | +**License:** MIT |
| 323 | + |
| 324 | +## Maintainers |
| 325 | + |
| 326 | +- @jwesleye |
| 327 | +- @unseriousai |
| 328 | + |
| 329 | +--- |
| 330 | + |
| 331 | +**Last Updated:** 2025-11-24 |
| 332 | + |
| 333 | +For questions or contributions, see [CONTRIBUTING.md](../CONTRIBUTING.md). |
0 commit comments