DocumentationPROPRO REQUIREDFC-DOC-008
API Spec Claw
api-spec-claw
v0.2.0May 22, 2026OpenAPI specs with schemas, endpoints, request/response examples, and authentication docs that stay in sync with the code
An OpenAPI spec with untyped responses and missing error schemas is just JSON-shaped optimism. I spec APIs with complete request/response models, auth scopes per endpoint, and example payloads that actually match production behavior — because the spec should be the contract, not the aspiration.
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
- Valid OpenAPI specification
- Schemas complete and validated
- Authentication documented
- Examples provided for all endpoints
- Error responses documented
3 GATES DEFINED
Expected Outputs
OpenAPI 3.1 Specification with Complete Error ModelsPostman Collection Generated from SpecAPI Changelog with Breaking-Change Warnings
Native exports per tool
OpenClaw10 files
openclaw/AGENTS.mdopenclaw/SOUL.mdopenclaw/TOOLS.md+7 moreHermes5 files
hermes/skills/flickclaw/api-spec-claw/SKILL.mdhermes/skills/flickclaw/api-spec-claw/references/workflow.mdhermes/skills/flickclaw/api-spec-claw/references/quality-gates.md+2 moreClaude Code6 files
claude-code/CLAUDE.mdclaude-code/.claude/skills/api-spec-claw/SKILL.mdclaude-code/.claude/skills/api-spec-claw/references/workflow.md+3 moreCodex5 files
codex/AGENTS.mdcodex/.flickclaw/agents/api-spec-claw/codex.mdcodex/.flickclaw/agents/api-spec-claw/workflow.md+2 moreCursor3 files
cursor/.cursor/rules/flickclaw-api-spec-claw.mdccursor/.cursor/rules/flickclaw-api-spec-claw-workflow.mdccursor/.cursor/rules/flickclaw-api-spec-claw-quality-gates.mdcWindsurf3 files
windsurf/.windsurf/rules/flickclaw-api-spec-claw.mdwindsurf/.windsurf/rules/flickclaw-api-spec-claw-workflow.mdwindsurf/.windsurf/rules/flickclaw-api-spec-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 api-spec-claw --target openclawDownload as ZIP
Example Prompt
Try this prompt with API Spec Claw to see what it can do:
Review the documentation and identify gaps. Generate OpenAPI 3.1 Specification with Complete Error Models, Postman Collection Generated from Spec, API Changelog with Breaking-Change Warnings covering setup, API reference, and troubleshooting.Example Output
IllustrativeWhat a typical API Spec Claw report looks like:
# API Spec Claw — Assessment Report **Project**: api-docs-site **Context**: a developer documentation site with OpenAPI specs and tutorials **Generated**: 2026-07-10 ## Executive Summary The API Spec 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_at_least_one_4xx_and_one_5xx_response_schema - [✓] all_schema_properties_are_explicitly_typed_no_loose_object - [✓] security_schemes_are_defined_and_scoped_per_operation ## Outputs Generated - **OpenAPI 3.1 Specification with Complete Error Models**: Included in the report above. - **Postman Collection Generated from Spec**: Included in the report above. - **API Changelog with Breaking-Change Warnings**: 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