mirror of
https://github.com/mergisi/awesome-openclaw-agents.git
synced 2026-08-14 00:47:49 +00:00
Productivity: Pulse (metrics), Standup, Inbox, Minutes Development: Lens (code review), Scribe (docs), Trace (bugs), Probe (API test), Log (changelog) Marketing: Buzz (social), Rank (SEO), Digest (newsletter), Scout (competitor) Business: Compass (support), Pipeline (sales), Ledger (invoices), Sentinel (churn) Personal: Atlas (planner), Scroll (reading), Iron (fitness) Each agent includes SOUL.md config and README.md with quick start, use cases, example outputs, and tips. Total: 23 agents. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
📖 Scribe - The Docs Writer
Your AI documentation writer that creates READMEs, API docs, and guides from your codebase.
Overview
Scribe writes and maintains your documentation:
- Generates README files from codebase analysis
- Creates API documentation with examples
- Writes setup guides and tutorials
- Keeps docs in sync with code changes
Quick Start
Installation
mkdir -p ~/.openclaw/agents/docs-writer/agent
cp SOUL.md ~/.openclaw/agents/docs-writer/agent/
openclaw agents add docs-writer --workspace ~/.openclaw/agents/docs-writer
First Conversation
openclaw chat docs-writer "Write a README for this project"
Use Cases
1. README Generation
You: "Write a README for this project"
Scribe: [Full README with description, quick start, features, usage, API, config]
2. API Documentation
You: "Document the /api/generate endpoint"
Scribe: [Parameters, return values, code examples, error cases]
3. Function Documentation
You: "Add JSDoc to this function"
Scribe: [Complete JSDoc with params, returns, examples, throws]
4. Setup Guide
You: "Write a setup guide for new developers"
Scribe: [Prerequisites, step-by-step, expected output, common errors]
Example Outputs
README
# AI2SQL
Convert natural language to SQL queries.
## Quick Start
npm install && npm run dev
Type: "Show users who signed up this week"
## Features
- MySQL, PostgreSQL, SQLite support
- Schema-aware queries
- CSV export
JSDoc
/**
* Generates SQL from natural language.
* @param prompt - Description of desired query
* @param options.dialect - SQL dialect (default: postgresql)
* @returns Generated SQL and explanation
* @example
* await generateSQL("Find active users");
*/
Tips
- Point to your codebase - Scribe reads files for accurate docs
- Ask for specific formats - README, API doc, JSDoc, guide
- Review examples - Make sure code samples actually work
- Update regularly - Run Scribe after major changes
Changelog
- v1.0.0 - Initial release with README generation
- v1.1.0 - API documentation and JSDoc
- v1.2.0 - Setup guides and tutorials
Author
Created by @openclaw
License
MIT