guidelines-advisor

Analyzes smart contract codebases against Trail of Bits development guidelines and produces prioritized recommendations.

Updated Mar 22, 2026
One-click install
npx skills add https://github.com/TECH-HY/SKILLS --skill guidelines-advisor-tech-hy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: guidelines-advisor
Source: https://github.com/TECH-HY/SKILLS/tree/main/skills/guidelines-advisor
Command: npx skills add https://github.com/TECH-HY/SKILLS --skill guidelines-advisor-tech-hy

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Smart contract teams often lack a systematic way to evaluate their codebase against established security and development best practices, leading to missed vulnerabilities, poor documentation, and weak testing before deployment. ## Core Features & Use Cases - Comprehensive Codebase Assessment: Reviews 11 areas including documentation, upgradeability, delegatecall proxies, inheritance, events, common pitfalls, dependencies, and testing. - Documentation Generation: Produces plain English system descriptions, architectural diagrams, and identifies NatSpec documentation gaps. - Prioritized Recommendations: Delivers findings ranked as CRITICAL, HIGH, MEDIUM, and LOW with file and line references. - Use Case: Before deploying a Solidity NFT marketplace, run this Skill to detect a reentrancy bug in the purchase function, flag a missing upgrade timelock, and get a week-by-week path to production readiness. ## Quick Start Analyze my smart contract codebase using Trail of Bits development guidelines and give me prioritized security and quality recommendations.

Frequently Asked Questions about guidelines-advisor

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review a smart contract codebase against Trail of Bits guidelines?

Invoke the guidelines-advisor Skill with access to your codebase. It explores contracts, tests, and dependencies, then assesses 11 areas including documentation, upgradeability, proxies, pitfalls, and testing, delivering prioritized recommendations with file references.

What does a smart contract development guidelines review check?

The review checks documentation completeness, on-chain versus off-chain architecture, upgradeability patterns, delegatecall proxy storage layout, function composition, inheritance depth, event coverage, common pitfalls like reentrancy, dependency quality, and test coverage.

Does this work with non-Solidity platforms like Rust or Cairo?

Yes, the Skill adapts to your platform including Solidity, Rust, and Cairo. Platform-specific guidance such as Solidity version recommendations and compiler warnings is applied where relevant, and it works even when tools like Slither are unavailable.

Can it analyze upgradeable proxy contracts for security issues?

Yes, it checks storage layout consistency, initialization patterns, function shadowing, and direct implementation usage risks for delegatecall proxies. It uses slither-check-upgradeability when available and falls back to manual pattern analysis otherwise.

What are the limitations of an automated smart contract guidelines review?

The review provides best-practice guidance and identifies common pitfalls, but it is not a substitute for a professional security audit. It may skip sections verified as not applicable and relies on available tooling, so complex novel vulnerabilities may require manual expert review.