guidelines-advisor SKILL.md skillA

guidelines-advisor from trailofbits/skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add trailofbits/skills/guidelines-advisor@git:20260825.32ad9e6

Pins git:20260825.32ad9e6 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
trailofbits/skills
Path
plugins/building-secure-contracts/skills/guidelines-advisor/SKILL.md
Versions recorded
3
Latest version
git:20260825.32ad9e6, committed Aug 25, 2026
First version recorded
Jan 26, 2026
Size
8,752 bytes
Repository stars
7,698
License
CC-BY-SA-4.0

Smart contract development advisor based on Trail of Bits' best practices. Analyzes codebase to generate documentation/specifications, review architecture, check upgradeability patterns, assess implementation quality, identify pitfalls, review dependencies, and evaluate testing. Use when asking whether a smart contract project follows development best practices, reviewing on-chain/off-chain split, upgradeability, or delegatecall proxy patterns against guidelines, or seeking recommendations on…

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# Guidelines Advisor

## Purpose

Systematically analyzes the codebase and provides guidance based on Trail of Bits' development guidelines:

1. **Generate documentation and specifications** (plain English descriptions, architectural diagrams, code documentation)
2. **Optimize on-chain/off-chain architecture** (only if applicable)
3. **Review upgradeability patterns** (if your project has upgrades)
4. **Check delegatecall/proxy implementations** (if present)
5. **Assess implementation quality** (functions, inheritance, events)
6. **Identify common pitfalls**
7. **Review dependencies**
8. **Evaluate test suite and suggest improvements**

**Framework**: Building Secure Contracts - Development Guidelines

---

## How This Works

### 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.)
- Testing setup
- Dependencies

### Phase 2: Documentation Generation
Helps create:
- Plain English system description
- Architectural diagrams (using Slither printers for Solidity)
- Code documentation recommendations (NatSpec for Solidity)
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add trailofbits/skills/guidelines-advisor@sha256:5bb8ba34d363c419

The line at the top of this page pins the label git:20260825.32ad9e6, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_pk7q4ozona3h5wnf.svg)](https://markdownregistry.com/a/art_pk7q4ozona3h5wnf)

1 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 3 versions of this file, between Jan 26, 2026 and Aug 25, 2026, about one every 106 days.

versioncommittedcommitsizeaudit
git:20260825.32ad9e6 latest2026-08-25 32ad9e6 8,752 BA view · diff
git:20260129.650f6e32026-01-29 650f6e3 8,486 BA view · diff
git:20260126.7af5b1b2026-01-26 7af5b1b 8,576 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (8752 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

trailofbits/skills · 7,698 stars · license CC-BY-SA-4.0 · pushed 2026-10-22 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_pk7q4ozona3h5wnf
GET https://markdownregistry.com/api/v1/resolve?ref=trailofbits/skills/guidelines-advisor
GET https://markdownregistry.com/api/v1/blob/5bb8ba34d363c419e1769a59d0fcc7444a04dc6d9e59032cb93019befdc2e464

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from trailofbits/skills

AGENTS.md AGENTS.md file
trailofbits/skills · AGENTS.md
git:20260916.123037e · audit B · 7,698 stars
CLAUDE.md CLAUDE.md file
trailofbits/skills · CLAUDE.md
git:20260605.f09e5c7 · audit B · 7,698 stars
agentic-actions-auditor SKILL.md skill
trailofbits/skills · plugins/agentic-actions-auditor/skills/agentic-actions-auditor/SKILL.md · Audits GitHub Actions workflows for security vulnerabilities in AI agent integrations including Claude Code Action…
git:20260831.9645e2f · audit A · 7,698 stars
audit-context-building SKILL.md skill
trailofbits/skills · plugins/audit-context-building/skills/audit-context-building/SKILL.md · Understand a codebase before looking for bugs in it - what each function assumes, what it guarantees, and what it…
git:20260828.d1f1575 · audit A · 7,698 stars
algorand-vulnerability-scanner SKILL.md skill
trailofbits/skills · plugins/building-secure-contracts/skills/algorand-vulnerability-scanner/SKILL.md · Scans Algorand smart contracts for 11 common vulnerabilities including rekeying attacks, unchecked transaction fees…
git:20260831.6feac67 · audit A · 7,698 stars
audit-prep-assistant SKILL.md skill
trailofbits/skills · plugins/building-secure-contracts/skills/audit-prep-assistant/SKILL.md · Prepares codebases for security review using Trail of Bits' checklist. Helps set review goals, runs static analysis…
git:20260825.32ad9e6 · audit A · 7,698 stars
cairo-vulnerability-scanner SKILL.md skill
trailofbits/skills · plugins/building-secure-contracts/skills/cairo-vulnerability-scanner/SKILL.md · Scans Cairo/StarkNet smart contracts for 6 critical vulnerabilities including felt252 arithmetic overflow, L1-L2…
git:20260831.6feac67 · audit A · 7,698 stars
code-maturity-assessor SKILL.md skill
trailofbits/skills · plugins/building-secure-contracts/skills/code-maturity-assessor/SKILL.md · Systematic code maturity assessment using Trail of Bits' 9-category framework. Analyzes codebase for arithmetic safety…
git:20260825.32ad9e6 · audit A · 7,698 stars
cosmos-vulnerability-scanner SKILL.md skill
trailofbits/skills · plugins/building-secure-contracts/skills/cosmos-vulnerability-scanner/SKILL.md · Scans Cosmos SDK blockchain modules and CosmWasm contracts for consensus-critical vulnerabilities — chain halts, fund…
git:20260401.d7f76b5 · audit A · 7,698 stars
secure-workflow-guide SKILL.md skill
trailofbits/skills · plugins/building-secure-contracts/skills/secure-workflow-guide/SKILL.md · Guides through Trail of Bits' 5-step secure development workflow. Runs Slither scans, checks special features…
git:20260825.32ad9e6 · audit A · 7,698 stars
solana-vulnerability-scanner SKILL.md skill
trailofbits/skills · plugins/building-secure-contracts/skills/solana-vulnerability-scanner/SKILL.md · Scans Solana programs for 6 critical vulnerabilities including arbitrary CPI, improper PDA validation, missing…
git:20260831.6feac67 · audit A · 7,698 stars
substrate-vulnerability-scanner SKILL.md skill
trailofbits/skills · plugins/building-secure-contracts/skills/substrate-vulnerability-scanner/SKILL.md · Scans Substrate/Polkadot pallets for 7 critical vulnerabilities including arithmetic overflow, panic DoS, incorrect…
git:20260831.6feac67 · audit A · 7,698 stars

Every file in trailofbits/skills

Browse by kind, by grade A, or by owner.