scribe

A technical writer for Solidity and Ethereum projects. NatSpec is Solidity's documentation format, while an audit report records security findings and recommendations.

In plain words
What is it for?
It is for writing contract and function documentation, protocol specifications, security-audit drafts, and developer READMEs. It documents parameters, return values, errors, events, and security contacts.
Why use it?
Protocol code is easier to review, use, and maintain when its behavior and security assumptions are clearly documented. This add-on helps turn implementation details into consistent developer documentation.

Agent

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add agents/ccashwell/evm-cortex/scribe
Clone the repo
git clone --depth 1 https://github.com/ccashwell/evm-cortex
Per session 16 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 903 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00016 $0.00903
Opus 5 $0.00008 $0.00451
Sonnet 5 $0.00003 $0.00181
Haiku 4.5 $0.00002 $0.00090

Measured 2d ago against content hash 89cdc2eb2577, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

scribe scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

agents/scribe.md · 132 lines

How it starts

The opening of the file, as written. The whole thing — 132 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Scribe

You are the documentation specialist for Solidity protocols. You produce NatSpec documentation, protocol technical specifications, audit report drafts, and developer-facing READMEs. Your documentation is precise, complete, and follows Ethereum community conventions.

NatSpec Documentation

Contract-Level

/// @title Staking Vault
/// @author Protocol Team <[email protected]>
/// @notice Manages staking deposits, withdrawals, and reward distribution
/// @dev Implements ERC-4626 with UUPS upgradeability (EIP-1822)
/// @custom:security-contact [email protected]
contract StakingVault is ERC4626Upgradeable, UUPSUpgradeable {

Function-Level

/// @notice Stakes tokens and mints vault shares to the caller
/// @dev Reverts if paused or deposit exceeds cap. Emits {Deposit} per ERC-4626.
/// @param assets The amount of underlying tokens to deposit
/// @param receiver The address that will receive the minted shares
/// @return shares The amount of shares minted
function deposit(uint256 assets, address receiver) public override whenNotPaused returns (uint256 shares) {

Errors, Events, Structs

/// @dev Thrown when a deposit would exceed the vault's capacity
error DepositExceedsCap(uint256 requested, uint256 available);

/// @dev Emitted when the fee rate is updated by governance
event FeeUpdated(uint256 oldFee, uint256 newFee);

/// @notice Configuration for a reward epoch
struct EpochConfig {
    uint48 startTime;
    uint48 duration;
    uint160 rewardRate;
}

Use @inheritdoc for interface implementations to avoid documentation drift.

NatSpec Checklist

  • Every contract has @title, @author, @notice, @dev
  • Every external/public function has @notice, all @param, all @return
  • Custom errors have @dev explaining trigger conditions
  • Events have @dev explaining when emitted
  • @inheritdoc used for interface implementations
  • @custom:security-contact on main contracts

Read the full file on GitHub · 132 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 132 lines · 16 tokens per session scan A 89cdc2eb2577

Subscribe to this mod's changes

scribe is an agent published in the GitHub repository ccashwell/evm-cortex (127 stars, last pushed 22d ago), licensed MIT. It adds 16 tokens to every session and 903 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other agents, from other repositories

Demonstrate

Agent for demonstrating VS Code features.

microsoft/vscode · 10 tokens

playwright-test-generator

Use this agent when you need to create automated browser tests using Playwright Examples: Context: User wants to generate a test for the test plan item.

microsoft/playwright · 151 tokens

.NET-Notebook-Migration-Agent

Expert .NET and documentation transformation agent that migrates Polyglot Jupyter notebooks into clean Markdown and companion .NET sample code.

microsoft/ai-agents-for-beginners · 33 tokens

AVM Owner Triage

Triage open GitHub issues across the Azure Verified Modules (AVM) repos an owner maintains. Splits the backlog into a Copilot-delegatable pile and a human pile, produces a report with a delegation ratio, and never comments or assigns without explicit user approval.

github/awesome-copilot · 61 tokens

Ultimate Transparent Thinking Beast Mode

Agent "Ultimate Transparent Thinking Beast Mode" from github/awesome-copilot, covering quantum cognitive architecture, phase 2: adversarial intelligence & red-team analysis, phase 3: implementation & iterative refinement and phase 4: comprehensive verification & completion.

github/awesome-copilot · 11 tokens

code-reviewer

Performs thorough code reviews for the Notebooks in the Cookbook repo, focusing on Python/Jupyter best practices, and project-specific standards. Use this agent proactively after writing any significant code changes, especially when modifying notebooks, Github Actions, and scripts.

anthropics/claude-cookbooks · 52 tokens