DocumentationPROPRO REQUIREDFC-DOC-014
Reference Doc Claw
reference-claw
v0.2.0May 25, 2026API reference docs with type definitions, parameter specs, and example collections that stay in sync with the codebase
API references that list parameters alphabetically with no grouping by use case are phone books, not documentation. I generate structured references organized by resource, with request/response examples for the happy path and the common failure modes, including rate limits, pagination, and idempotency behavior.
OpenClaw
Hermes
Claude Code
Codex
Cursor
Windsurf
Aider
OllamaPRIMARY ACTION
Unlock with ProCOMPATIBLE WITH
OpenClawHermesClaude CodeCodex+4
8 compatible tools3 output formats
When to Use
- Create practical README and setup docs
- Document API behavior with clarity
- Maintain reliable changelogs
- Reduce onboarding friction
Compatible Frameworks
OpenClawHermesClaude CodeCodexCursorWindsurfAiderOllama8 TOOLS
Quality Gates
- no fake claims
- typed parameters complete
- response schemas valid
- code examples tested
3 GATES DEFINED
Expected Outputs
API Reference Document (Grouped by Resource)Interactive API Explorer Config (e.g. Scalar/Redoc)Endpoint-to-Use-Case Cross-Reference Matrix
Native exports per tool
OpenClaw10 files
openclaw/AGENTS.mdopenclaw/SOUL.mdopenclaw/TOOLS.md+7 moreHermes5 files
hermes/skills/flickclaw/reference-claw/SKILL.mdhermes/skills/flickclaw/reference-claw/references/workflow.mdhermes/skills/flickclaw/reference-claw/references/quality-gates.md+2 moreClaude Code6 files
claude-code/CLAUDE.mdclaude-code/.claude/skills/reference-claw/SKILL.mdclaude-code/.claude/skills/reference-claw/references/workflow.md+3 moreCodex5 files
codex/AGENTS.mdcodex/.flickclaw/agents/reference-claw/codex.mdcodex/.flickclaw/agents/reference-claw/workflow.md+2 moreCursor3 files
cursor/.cursor/rules/flickclaw-reference-claw.mdccursor/.cursor/rules/flickclaw-reference-claw-workflow.mdccursor/.cursor/rules/flickclaw-reference-claw-quality-gates.mdcWindsurf3 files
windsurf/.windsurf/rules/flickclaw-reference-claw.mdwindsurf/.windsurf/rules/flickclaw-reference-claw-workflow.mdwindsurf/.windsurf/rules/flickclaw-reference-claw-quality-gates.mdAider3 files
aider/CONVENTIONS.mdaider/aider.mdaider/.aider.conf.ymlOllama4 files
ollama/Modelfileollama/system-prompt.mdollama/template.md+1 moreInstall Commands
Install the FlickClaw CLI, then select your AI agent framework below to get the correct install command.
Step 1: Install CLI (one-time)
npm install -g @flickclaw/cli@latestStep 2: Select Framework
OpenClaw
npm exec --yes @flickclaw/cli@latest -- install reference-claw --target openclawDownload as ZIP
Example Prompt
Try this prompt with Reference Doc Claw to see what it can do:
Review the documentation and identify gaps. Generate API Reference Document (Grouped by Resource), Interactive API Explorer Config (e.g. Scalar/Redoc), Endpoint-to-Use-Case Cross-Reference Matrix covering setup, API reference, and troubleshooting.Example Output
IllustrativeWhat a typical Reference Doc Claw report looks like:
# Reference Doc Claw — Assessment Report **Project**: api-docs-site **Context**: a developer documentation site with OpenAPI specs and tutorials **Generated**: 2026-07-10 ## Executive Summary The Reference Doc Claw completed its review of api-docs-site (a developer documentation site with OpenAPI specs and tutorials). 3 findings were identified with concrete remediation steps. All quality gates were verified before delivery. ## Findings | # | Severity | Area | Finding | Recommended Action | |---|----------|------|---------|-------------------| | 1 | **P1** | Structure | Quickstart buried 3 levels deep in navigation | Promote Quickstart to top-level with 5-minute timebox | | 2 | **P2** | Completeness | Webhook events missing from API reference | Document all webhook types with payload examples | | 3 | **P2** | Examples | Code samples lack error handling | Add try/catch blocks and error response examples | ## Quality Gates - [✓] every_endpoint_has_a_curl_example_that_runs_as_is - [✓] pagination_rate_limits_and_idempotency_are_documented_per_endpoint - [✓] response_fields_are_grouped_by_resource_not_alphabetically ## Outputs Generated - **API Reference Document (Grouped by Resource)**: Included in the report above. - **Interactive API Explorer Config (e.g. Scalar/Redoc)**: Included in the report above. - **Endpoint-to-Use-Case Cross-Reference Matrix**: Included in the report above. ## Validation - [x] All quality gates passed (3/3) - [x] 3 findings documented with severity and remediation - [x] 3 output sections generated - [x] Evidence collected and referenced --- *This is an illustrative example output from FlickClaw. Results vary based on project context.*
RELATED AGENTS