Clean up stale documentation audit findings (#10114)
Co-authored-by: Douwe M Osinga <douwe@sidewalklabs.com>
This commit is contained in:
@@ -5,7 +5,7 @@ description: Understand codebases with semantic analysis and call graphs
|
||||
sidebar_position: 111
|
||||
---
|
||||
|
||||
The [Developer extension](/docs/mcp/developer-mcp) includes an `analyze` tool that helps you understand code structure, track symbol usage, and explore call graphs across your codebase. It's automatically available when the Developer extension is enabled and supports file types for [multiple programming languages](https://github.com/aaif-goose/goose/blob/main/crates/goose-mcp/src/developer/analyze/languages/mod.rs).
|
||||
The Analyze platform extension provides an `analyze` tool that helps you understand code structure, track symbol usage, and explore call graphs across your codebase. It is enabled by default and supports file types for [multiple programming languages](https://github.com/aaif-goose/goose/blob/main/crates/goose/src/agents/platform_extensions/analyze/languages.rs).
|
||||
|
||||
<details>
|
||||
<summary>Example analysis: Tracking a function across files</summary>
|
||||
@@ -103,13 +103,13 @@ analyze path="." focus="UserClass" follow_depth=3
|
||||
| `focus` | None | Name of the symbol to track. For cross-file tracking, `path` must be a directory. |
|
||||
| `follow_depth` | 2 | How many steps to trace from the focused symbol (0=where defined, 1=immediate callers/callees, 2=their callers/callees, etc.). Used with the `focus` parameter. |
|
||||
| `max_depth` | 3 | How many subdirectory levels to analyze when `path` is a directory (0=unlimited) |
|
||||
| `force` | false | Receive full analysis results (otherwise, only a warning message is shown when the results exceed 1000 lines) |
|
||||
| `force` | false | Receive full analysis results (otherwise, only a warning message is shown when the results exceed 50,000 characters) |
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Handling Large Outputs
|
||||
|
||||
If the analysis results exceed 1000 lines, the tool returns a warning message instead of the analysis. Options for managing large outputs:
|
||||
If the analysis results exceed 50,000 characters, the tool returns a warning message instead of the analysis. Options for managing large outputs:
|
||||
|
||||
- **Use `force=true`** to bypass the warning and see the full output (may consume significant conversation context)
|
||||
- **Narrow your scope** by analyzing a specific subdirectory or file
|
||||
@@ -120,4 +120,4 @@ If the analysis results exceed 1000 lines, the tool returns a warning message in
|
||||
|
||||
- Start with smaller scopes (specific files or subdirectories) before analyzing entire projects
|
||||
- Use `max_depth=1` or `max_depth=2` to limit directory traversal depth
|
||||
- Use `.gitignore` files to exclude unnecessary files from analysis, such as `node_modules/` and build artifacts
|
||||
- Use `.gitignore` files to exclude unnecessary files from analysis, such as `node_modules/` and build artifacts
|
||||
|
||||
Reference in New Issue
Block a user