Skip to content
SkillModel-led1,657 tokens in use

Guidelines Advisor

Reviews a smart contract project against Trail of Bits' development guidelines and returns documentation, an architecture review and prioritized recommendations.

8,319 stars on the repository CC-BY-SA-4.0trailofbits/skills · plugins/building-secure-contracts/skills/guidelines-advisor
/plugin marketplace add trailofbits/skills
View source

Install command as written in the repository's README

Skill label

measured from its files

What installing Guidelines Advisor costs

100tokens idle
1,657tokens in use
5,860tokens, up to

Idle is what sits in context while the skill is installed. In use is its instructions, loaded when it runs. Up to adds the files its instructions link. Counts are approximate, made offline with cl100k_base.

Model dependence Model-led

Script-ledMixedModel-led

Mostly instructions, so how well it works depends on the model that follows them.

This describes the skill's structure, how much of it is scripts. It does not say how well it works.

Touches

Nothing detected: no shell, network, file writes, git or credentials in its files.

Declared tags come from the skill's frontmatter; detected ones from its scripts, its code blocks and the commands it names in inline code. This is detected, not audited.

How it scores

Quality

How well the skill is written, counted from its own files: its frontmatter, its steps, examples, stated output and constraints, its size and whether every file it ships is one it names.How we score it →
Excellent
  • Frontmatter12/15
  • Structure25/25
  • Examples3/15
  • Output15/15
  • Size15/15
  • Resources11/15

Security

Starts at 100 and loses points for each thing in the skill's files that a reader should look at first.How we score it →
Excellent

No findings.

Repository health

Pre-computed score based on development activity, maintenance, community, maturity, and trend momentum.How we score it →
Good
  • Development activity100
  • Maintenance52
  • Community64
  • Maturity32
  • Momentum40

Guidelines Advisor analyzes a smart contract codebase across eleven areas: documentation, on-chain and off-chain split, upgradeability, delegatecall proxies, function composition, inheritance, events, common pitfalls, dependencies, testing and platform guidance.

It generates a system description and diagrams, reviews only the sections that apply, asks about design decisions it cannot infer, and ends with recommendations ranked critical, high, medium and low.

What You Get

  • A system description in everyday English with architectural diagrams and a list of documentation gaps
  • An architecture analysis covering on-chain and off-chain split, upgradeability and proxy patterns
  • An implementation review of functions, inheritance, events, pitfalls, dependencies and tests
  • Recommendations ranked critical, high, medium and low with file references

Common Use Cases

  • Asking whether a project follows smart contract development best practices
  • Reviewing upgrade and delegatecall proxy patterns for storage and initialization risks
  • Getting recommendations on inheritance, events and documentation
  • Deciding on a test strategy before an audit

What Makes It Unique

The advisor scopes itself to what the project contains, so it does not invent upgrade problems in a contract with no upgrades, yet it must search for implicit proxies and delegatecall before declaring a section not applicable. Findings must be specific to the project with file and line references, and generic best-practice advice is explicitly rejected.

Under The Hood

The skill is an instruction file with linked resources for assessment areas, deliverable templates and an example report. The agent explores the project with file reads and search, may run Slither printers to generate diagrams when Slither is installed, and writes its findings as a response. It does not fetch web pages or call remote services.

Join founders building with open source

Opinionated takes, migration guides, cost-saving tips, and insights from the open source ecosystem.

Subscribe on SubstackJoin 750+ subscribers