Individual skill
natspec-standards
NatSpec documentation standards for Solidity contracts. Use when writing or reviewing contract documentation. Every public and external function must have NatSpec. Covers all tags, formatting conventions, and complete examples.
skills/natspec-standards/SKILL.md
Source commit a53141f10a1bbf9c634e44af6bc5a29dd1660697
What was checked
- Matches the observed repository HEAD
- Yes
- Scanner rules are current
- No
- Repository scan complete
- No
- Skill scan complete
- Yes
- Observed behavior
- Not checked yet
- Last checked
- Nov 7, 2026
These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.
Install this skill
Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.
An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.
Repository context
- Repository stars (not skill ratings)
- 132
- Repository last updated
- Oct 23, 2026
- License
- MIT
Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.
Files and excerpt
File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.
Browse files
SKILL.mdcore · 6,532 bytes
Read excerpt
# NatSpec Standards
## Required Documentation
Every public and external function **must** have NatSpec. Internal functions that are non-trivial should also be documented.
## Tags Reference
| Tag | Context | Description |
|-----|---------|-------------|
| `@title` | Contract/interface | Title of the contract |
| `@author` | Contract/interface | Author name or team |
| `@notice` | Contract/function/event/error | User-facing explanation (shown in etherscan) |
| `@dev` | Contract/function/event/error | Developer-facing technical details |