admin/ruflo

0 Fork 0

mirror of https://github.com/ruvnet/ruflo.git synced 2026-10-23 03:47:00 +09:00

Files

T

randRuFlo ac583cd342 fix(plugins): group B skills and agents use real CLI flags and MCP parameter names

Verified every CLI flag and MCP call example in ruflo-core, cost-tracker, daa,
ddd, deepseek-harness, docs, federation and goals against the published CLI
(3.56.5) and the tool schemas in source:

- hooks post-task has no --train-neural (8 agents/skills); neural train takes
  --pattern, not --pattern-type; hooks worker dispatch takes --context, not
  --scope (docs scoping was silently ignored).
- agentdb_* examples used non-existent parameters (semantic-route query ->
  input; causal-edge from/to/type -> sourceId/targetId/relation; hierarchical
  store/recall path/data/depth -> key/value/tier and query/topK; pattern-search
  limit -> topK; context-synthesize sources -> maxEntries); ddd skills used a
  CLI-style --parent/--child form that failed on required key/value. The
  researcher agent now follows edges with graph-query/graph-pathfinder.
- hooks_worker-status has no worker filter; cost docs now filter the result.
- dossier-collect/investigator fetch web content: add untrusted-content rules
  and AIDefence screening. deepseek skills state the data egress.
- Stale smoke/tool/command counts and four dead relative links fixed.

Patch-bumps each changed plugin with a CHANGELOG entry.

Co-Authored-By: RuFlo <ruv@ruv.net>

2026-10-11 11:26:09 -04:00

3.4 KiB

Raw Permalink Blame History

ruflo-docs

Documentation generation, drift detection, and API docs automation.

Install

/plugin marketplace add ruvnet/ruflo
/plugin install ruflo-docs@ruflo

What's Included

Auto-Documentation: Background worker generates docs from code changes
Drift Detection: Identifies when docs fall out of sync with implementation
API Docs: Automated API documentation from TypeScript interfaces and JSDoc
CAPABILITIES.md Generation: Full capabilities reference via init command
Document Worker: Background document worker triggers on API changes
SPARC Integration: Uses documenter and docs-writer agent patterns

Requires

ruflo-core plugin (provides MCP server)

Compatibility

CLI: pinned to @claude-flow/cli v3.6 major+minor.
Agent model: Haiku (cost-efficient for docs work).
Verification: bash plugins/ruflo-docs/scripts/smoke.sh is the contract.

Document-worker contract

Drives the document background worker (one of 12 workers in CLAUDE.md). Two invocation paths:

# CLI
npx @claude-flow/cli@latest hooks worker dispatch --trigger document
npx @claude-flow/cli@latest hooks worker dispatch --trigger document --context api

# MCP
mcp tool call hooks_worker-dispatch --json -- '{"trigger": "document", "context": "api"}'

Context	Output
(none)	Full project documentation pass
`api`	API reference from JSDoc/TSDoc + OpenAPI 3.0 for HTTP endpoints
`<file-path>`	Single-file doc generation

Namespace coordination

This plugin owns the docs-drift AgentDB namespace (kebab-case, follows the convention from ruflo-agentdb ADR-0001 §"Namespace convention"). Used for drift-detection state (last-seen export hash per file). Reserved namespaces (pattern, claude-memories, default) MUST NOT be shadowed.

docs-drift is accessed via memory_* tools (namespace-routed).

Verification

bash plugins/ruflo-docs/scripts/smoke.sh
# Expected: "13 passed, 0 failed"

Architecture Decisions

ADR-0001 — ruflo-docs plugin contract (document-worker integration, namespace coordination, smoke as contract)

ruflo-agentdb — namespace convention owner
ruflo-loop-workers — defines the document background worker
ruflo-adr — ADRs trigger doc generation when status changes
ruflo-sparc — Documenter mode (Phase 5 Refinement) consumes this plugin

As a mod

Since this version the plugin is also a function-hook mod (ADR-445 pattern; needs Claude Code 2.1.287 or later). It never calls the network or spawns a process, and it only tightens: it can refuse a call, never allow one.

Guard (default on): refuses doc-* memory writes and the document worker dispatch that hold a key, token or password. The reason names the kind of secret, never the value.
/docs-mod: answered locally, no model turn: status, scan <text> (would the guard refuse this?), and docs (markdown files in docs/).
Status file: .claude-flow/docs-mod/status.json ({version, updatedMs, guard, blocked}), written at session start and when a call is blocked.
Option: guard (on | off, default on) in the plugin's userConfig.

Test it: claude plugin test plugins/ruflo-docs and bash plugins/ruflo-docs/scripts/smoke.sh.

3.4 KiB Raw Permalink Blame History