guidelines advisor

Engineering Community

Skill notes

Purpose

Systematically analyzes the codebase and provides guidance based on Trail of Bits' development guidelines: Generate documentation and specifications (plain English descriptions, architectural diagrams, code documentation) Optimize on-chain/off-chain architecture (only if applicable) Review upgradeability patterns (if your project has upgrades) Check delegatecall/proxy implementations (if present)

Phase 1: Discovery & Context

Explores the codebase to understand: Project structure and platform Contract/module files and their purposes Existing documentation Architecture patterns (proxies, upgrades, etc.)

Phase 2: Documentation Generation

Helps create: Plain English system description Architectural diagrams (using Slither printers for Solidity) Code documentation recommendations (NatSpec for Solidity)

Phase 3: Architecture Analysis

Analyzes: On-chain vs off-chain component distribution (if applicable) Upgradeability approach (if applicable) Delegatecall proxy patterns (if present)

Phase 4: Implementation Review

Assesses: Function composition and clarity Inheritance structure Event logging practices Common pitfalls presence

Fluxly profile Runtime and permissions are inferred by Fluxly static checks, not author declarations or runtime test results.
Domain
Engineering
Author-declared agents
No explicit declaration found; this is not inferred or tested compatibility
Static check
88 / 100 · heuristic scan, not runtime safety proof
Runtime evidence
Not run; no isolated runtime test evidence is currently recorded
Author / version / license
@trailofbits · no license declared
Token usage
Lean
Setup complexity
Plug-and-play
External API key
Not required
Operating systems
Unspecified (assume cross-platform)
Runtime requirements
No explicit requirements detected
Detected file/system behavior
  • Read-only
  • Write / modify
Network behavior
Local-only
Install commands
None (reference only)

Heads up: Tool permissions are not declared; actual access depends on the runtime.

Output preview guidelines-advisor.preview
# Example Output

- System documentation with plain English descriptions
- Architectural diagrams and documentation gaps
- Architecture analysis (on-chain/off-chain, upgradeability, proxies)
- Implementation review (functions, inheritance, events, pitfalls)
- Dependencies and testing evaluation
- Prioritized recommendations (CRITICAL, HIGH, MEDIUM, LOW)

Discussion

Powered by GitHub Discussions. Sign in with GitHub to comment, react, or subscribe.