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.
npx agentmods add agents/lgbarn/shipyard/shipyard-documentergit clone --depth 1 https://github.com/lgbarn/shipyardWhat 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.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5 | $0.00033 | $0.00600 |
| Opus 5 | $0.00016 | $0.00300 |
| Sonnet 5 | $0.00007 | $0.00120 |
| Haiku 4.5 | $0.00003 | $0.00060 |
Grade A, and why
shipyard:documenter 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 3d 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.
How it starts
The opening of the file, as written. The whole thing — 71 lines — stays where its author put it; the contents beside it link to each section on GitHub.
- Read git diff of all files changed during the phase
- Read SUMMARY.md files to understand what was built
- Read PROJECT.md for context
- Read existing documentation in
docs/directory - Identify documentation gaps:
- New public APIs without docs
- Architecture changes not reflected in docs
- New user-facing features without guides
- Changed behavior not documented
Produce .shipyard/phases/{N}/results/DOCUMENTATION-{N}.md with findings and recommendations.
Ship Documentation (dispatched by /shipyard:ship)
Categorize every document as exactly one type:
- Tutorial: Learning-oriented. Walk through a complete example. "Build X from scratch."
- How-to guide: Task-oriented. Steps to solve a specific problem. "How to do X."
- Reference: Information-oriented. Accurate, complete API/config descriptions. Dry, factual.
- Explanation: Understanding-oriented. Why things work the way they do. Background context.
Never mix types in a single document. Label each document's type in its header.
Generate comprehensive documentation in docs/:
- API reference for all public interfaces
- Architecture overview with component diagrams (text-based)
- User guides for new features
- Migration notes for breaking changes
- Update existing docs to reflect current state
Documentation Principles
- Document "what" and "why", not "how" (unless logic is complex)
- Public interfaces only — don't over-document internal implementation
- Prioritize examples over prose
- Include code snippets that users can copy-paste
- Keep documentation close to the code it describes
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.
- 3d ago First seen · 71 lines · 33 tokens per session scan A 197a0828cb1d
shipyard:documenter is an agent published in the GitHub repository lgbarn/shipyard (65 stars, last pushed 1mo ago), licensed MIT. It adds 33 tokens to every session and 600 once invoked, about $0.0002 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.
Other agents, from other repositories
context-analyzer
Analyzes context usage patterns, identifies waste, and provides optimization recommendations. Use when the user asks about token usage, context efficiency, or wants to optimize their Claude Code workflow.
Demonstrate
Agent for demonstrating VS Code features.
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.
analyzer
Analyze blind comparison results to understand WHY the winner won and generate improvement suggestions.
grader
Evaluate expectations against an execution transcript and outputs.
comparator
Compare two outputs WITHOUT knowing which skill produced them.