guidelines-advisor

Analyze Solidity codebases to generate documentation, architecture analysis, and prioritized recommendations.

2|Updated Jan 21, 2026
One-click install
npx skills add https://github.com/roderik/mpe --skill guidelines-advisor
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: guidelines-advisor
Source: https://github.com/roderik/mpe/tree/main/.agents/skills/guidelines-advisor
Command: npx skills add https://github.com/roderik/mpe --skill guidelines-advisor

SYSTEM DOCUMENTATION & REQUIREMENTS

## What problem does it solve? This Skill systematically analyzes a Solidity codebase to generate comprehensive documentation, architecture guidance, upgradeability assessments, and actionable recommendations aligned with Trail of Bits' development guidelines.

## Core Features & Use Cases

  • Documentation & Specifications: produce plain-English system descriptions, architectural diagrams, NatSpec recommendations, and documentation gaps.
  • Architecture & Design Review: evaluate system architecture, module interactions, and overall design quality to inform improvements.
  • Upgradeability & Proxy Assessment: analyze upgrade paths, migration considerations, and proxy/delegatecall patterns to identify risks and remedies.
  • Implementation Quality & Safety: assess function composition, inheritance structures, event coverage, and potential pitfalls.
  • Dependencies & Testing Review: review external libraries, dependency management, and testing strategy with improvement suggestions.
  • Actionable Recommendations: deliver prioritized next steps and a practical roadmap for production-readiness.

### Quick Start Run guidelines-advisor on your Solidity project to generate a full assessment report.

Frequently Asked Questions about guidelines-advisor

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

FAQPage Schema
How do I generate architecture documentation for a Solidity smart contract codebase?

Analyze your Solidity codebase to produce plain-English system descriptions, architectural diagrams, and NatSpec recommendations. This assessment identifies documentation gaps and evaluates module interactions to inform structural improvements.

How do I assess upgradeability risks and proxy patterns in smart contracts?

Assess upgradeability risks by analyzing upgrade paths, migration considerations, and proxy or delegatecall patterns. This review identifies potential vulnerabilities and provides actionable remedies to ensure safe contract upgrades across deployment environments.

What is the best way to review implementation quality and safety in Solidity contracts?

Review implementation quality by assessing function composition, inheritance structures, and event coverage. This analysis identifies potential pitfalls and evaluates overall design architecture to deliver prioritized remediation steps for production-readiness.

Can I use this analysis on projects with varying sizes and complex proxy patterns?

Yes, this analysis is applicable to Solidity projects of varying sizes, including those using upgradeable contracts and proxy patterns. It generates consistent guidance and structured outputs across different deployment environments.

How do I review external dependencies and testing strategy for smart contracts?

Review external dependencies by analyzing library management and testing strategies within your Solidity project. This evaluation provides targeted improvement suggestions for dependency handling and test coverage to enhance overall system reliability.