Skip to content

Commit 187b171

Browse files
committed
docs: Fix workflow references and module paths for v0.7.0
Updated all documentation to reflect actual v0.7.0 workflow implementation: Workflow name changes: - Removed all references to non-existent workflows (static_analysis_scan, secret_detection_scan, infrastructure_scan, penetration_testing_scan) - Updated examples to use actual workflows (security_assessment, gitleaks_detection, trufflehog_detection, llm_secret_detection) - Deleted docs/docs/reference/workflows/static-analysis.md (described non-existent workflow) Content corrections: - Fixed workflow tool descriptions (removed incorrect Semgrep/Bandit references, documented actual SecurityAnalyzer and FileScanner modules) - Updated all workflow lists to show production-ready vs development status - Fixed all example configurations to match actual workflow parameters Module creation guide fixes: - Fixed 4 path references: backend/src/toolbox → backend/toolbox - Updated import statements in example code Files updated: - docs/index.md - workflow list, CLI example, broken tutorial links - docs/docs/tutorial/getting-started.md - workflow list, example output, tool descriptions - docs/docs/how-to/create-module.md - module paths and imports - docs/docs/how-to/mcp-integration.md - workflow examples and list - docs/docs/ai/prompts.md - workflow example - docs/docs/reference/cli-ai.md - 3 workflow references
1 parent f14bec9 commit 187b171

File tree

7 files changed

+69
-309
lines changed

7 files changed

+69
-309
lines changed

docs/docs/ai/prompts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Use the `fuzzforge ai agent` shell to mix structured slash commands with natural
2020
You> list available fuzzforge workflows
2121
Assistant> [returns workflow names, descriptions, and required parameters]
2222
23-
You> run fuzzforge workflow static_analysis_scan on ./backend with target_branch=main
23+
You> run fuzzforge workflow security_assessment on ./backend
2424
Assistant> Submits the run, emits TaskStatusUpdateEvent entries, and links the SARIF artifact when complete.
2525
2626
You> show findings for that run once it finishes

docs/docs/how-to/create-module.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ All FuzzForge modules inherit from a common `BaseModule` interface and use Pydan
2525
- `ModuleResult`: Standardized result format for module execution
2626
- `ModuleMetadata`: Describes module capabilities and requirements
2727

28-
Modules are located in `backend/src/toolbox/modules/`.
28+
Modules are located in `backend/toolbox/modules/`.
2929

3030
---
3131

@@ -34,7 +34,7 @@ Modules are located in `backend/src/toolbox/modules/`.
3434
Let’s create a simple example: a **License Scanner** module that detects license files and extracts license information.
3535

3636
Create a new file:
37-
`backend/src/toolbox/modules/license_scanner.py`
37+
`backend/toolbox/modules/license_scanner.py`
3838

3939
```python
4040
import re
@@ -98,7 +98,7 @@ class LicenseScanner(BaseModule):
9898

9999
## Step 3: Register Your Module
100100

101-
Add your module to `backend/src/toolbox/modules/__init__.py`:
101+
Add your module to `backend/toolbox/modules/__init__.py`:
102102

103103
```python
104104
from .license_scanner import LicenseScanner
@@ -115,7 +115,7 @@ Create a test file (e.g., `test_license_scanner.py`) and run your module against
115115
```python
116116
import asyncio
117117
from pathlib import Path
118-
from backend.src.toolbox.modules.license_scanner import LicenseScanner
118+
from toolbox.modules.license_scanner import LicenseScanner
119119

120120
async def main():
121121
workspace = Path("/path/to/your/test/project")

docs/docs/how-to/mcp-integration.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -81,14 +81,17 @@ You should see status responses and endpoint listings.
8181
{
8282
"tool": "submit_security_scan_mcp",
8383
"parameters": {
84-
"workflow_name": "infrastructure_scan",
84+
"workflow_name": "security_assessment",
8585
"target_path": "/path/to/your/project",
8686
"parameters": {
87-
"checkov_config": {
88-
"severity": ["HIGH", "MEDIUM", "LOW"]
87+
"scanner_config": {
88+
"patterns": ["*"],
89+
"check_sensitive": true
8990
},
90-
"hadolint_config": {
91-
"severity": ["error", "warning", "info", "style"]
91+
"analyzer_config": {
92+
"file_extensions": [".py", ".js", ".java"],
93+
"check_secrets": true,
94+
"check_sql": true
9295
}
9396
}
9497
}
@@ -110,13 +113,17 @@ You should see status responses and endpoint listings.
110113

111114
## 6. Available Workflows
112115

113-
You can trigger these workflows via MCP:
116+
You can trigger these production-ready workflows via MCP:
114117

115-
1. **infrastructure_scan** — Docker/Kubernetes/Terraform security analysis
116-
2. **static_analysis_scan** — Code vulnerability detection
117-
3. **secret_detection_scan** — Credential and secret scanning
118-
4. **penetration_testing_scan** — Network and web app testing
119-
5. **security_assessment** — Comprehensive security evaluation
118+
1. **security_assessment** — Comprehensive security analysis (secrets, SQL, dangerous functions)
119+
2. **gitleaks_detection** — Pattern-based secret scanning
120+
3. **trufflehog_detection** — Pattern-based secret scanning
121+
4. **llm_secret_detection** — AI-powered secret detection (requires API key)
122+
123+
Development workflows (early stages):
124+
- **atheris_fuzzing** — Python fuzzing
125+
- **cargo_fuzzing** — Rust fuzzing
126+
- **ossfuzz_campaign** — OSS-Fuzz integration
120127

121128
List all workflows:
122129

docs/docs/reference/cli-ai.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -134,14 +134,16 @@ FuzzForge supports the Model Context Protocol (MCP), allowing LLM clients and AI
134134
{
135135
"tool": "submit_security_scan_mcp",
136136
"parameters": {
137-
"workflow_name": "infrastructure_scan",
137+
"workflow_name": "security_assessment",
138138
"target_path": "/path/to/your/project",
139139
"parameters": {
140-
"checkov_config": {
141-
"severity": ["HIGH", "MEDIUM", "LOW"]
140+
"scanner_config": {
141+
"patterns": ["*"],
142+
"check_sensitive": true
142143
},
143-
"hadolint_config": {
144-
"severity": ["error", "warning", "info", "style"]
144+
"analyzer_config": {
145+
"file_extensions": [".py", ".js"],
146+
"check_secrets": true
145147
}
146148
}
147149
}
@@ -161,11 +163,16 @@ FuzzForge supports the Model Context Protocol (MCP), allowing LLM clients and AI
161163

162164
### Available Workflows
163165

164-
1. **infrastructure_scan** — Docker/Kubernetes/Terraform security analysis
165-
2. **static_analysis_scan** — Code vulnerability detection
166-
3. **secret_detection_scan** — Credential and secret scanning
167-
4. **penetration_testing_scan** — Network and web app testing
168-
5. **security_assessment** — Comprehensive security evaluation
166+
**Production-ready:**
167+
1. **security_assessment** — Comprehensive security analysis (secrets, SQL, dangerous functions)
168+
2. **gitleaks_detection** — Pattern-based secret scanning
169+
3. **trufflehog_detection** — Pattern-based secret scanning
170+
4. **llm_secret_detection** — AI-powered secret detection (requires API key)
171+
172+
**In development:**
173+
- **atheris_fuzzing** — Python fuzzing
174+
- **cargo_fuzzing** — Rust fuzzing
175+
- **ossfuzz_campaign** — OSS-Fuzz integration
169176

170177
### MCP Client Configuration Example
171178

@@ -192,7 +199,7 @@ FuzzForge supports the Model Context Protocol (MCP), allowing LLM clients and AI
192199
`curl http://localhost:8000/workflows/`
193200

194201
- **Scan Submission Errors:**
195-
`curl -X POST http://localhost:8000/workflows/infrastructure_scan/submit -H "Content-Type: application/json" -d '{"target_path": "/your/path"}'`
202+
`curl -X POST http://localhost:8000/workflows/security_assessment/submit -H "Content-Type: application/json" -d '{"target_path": "/your/path"}'`
196203

197204
- **General Support:**
198205
- Check Docker Compose logs: `docker compose logs fuzzforge-backend`

0 commit comments

Comments
 (0)