agentweaver-docs-sync

A procedure for keeping Agentweaver documentation aligned with the software's source code. Agentweaver is a multi-agent application whose documentation includes both generated reference pages and hand-written guides.

In plain words
What is it for?
Finding which documentation needs updates, regenerating derived pages, checking for documentation drift, and building the VitePress documentation site.
Why use it?
It reduces mismatches between changed features and the pages that explain them.

Skill for Claude CodeCodex

Install

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.

agentmods
npx agentmods add skills/sabbour/agentweaver/agentweaver-docs-sync
Any agent
npx skills add sabbour/agentweaver --skill agentweaver-docs-sync
Clone the repo
git clone --depth 1 https://github.com/sabbour/agentweaver

Made for: Claude Code, Codex.

Per session 40 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 999 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What 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.

ModelPer sessionOnce invoked
Fable 5 $0.00040 $0.00999
Opus 5 $0.00020 $0.00500
Sonnet 5 $0.00008 $0.00200
Haiku 4.5 $0.00004 $0.00100

Measured 3d ago against content hash 59fa81a733b1, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

agentweaver-docs-sync 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.

.copilot/skills/agentweaver-docs-sync/SKILL.md · 71 lines

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.

Context

Docs live in docs/ (a VitePress site) and drift from the code as features land. This skill is the repeatable playbook so doc updates are deterministic instead of a one-off prompt. See .github/DOCS_SYNC.md for the full strategy.

Companion skill. This skill owns drift detection and generated/derived docs (the generator + CI check). To author a feature's docs across all facets (deep-dive, reference, user guide, screenshots, landing card, nav, cross-links, diagrams), use the docs-feature skill. Use them together: docs-feature to write, docs-sync to keep generated docs in sync.

Docs are split into two kinds:

  • Generated — derived from source, never hand-edited (carry a GENERATED — DO NOT EDIT header).
  • Curated — hand-written prose.
Surface Doc Mode Source of truth
MCP tools docs/reference/mcp-tools.md Generated apps/Agentweaver.Mcp/Tools/*.cs
MCP tool params docs/reference/mcp.md Curated hand-written
API endpoints docs/reference/api.md Curated apps/Agentweaver.Api/**/*Endpoints.cs
Memory/decisions docs/reference/memory.md Curated apps/Agentweaver.Api/Endpoints/{Memory,Decisions}Endpoints.cs
Blueprints/workflows docs/guide/workflows.md, docs/reference/* Curated apps/Agentweaver.Api/{Blueprints,Workflows}/, packages/Agentweaver.Squad/Catalog/Resources/blueprints/

When to invoke

Invoke this skill whenever a change adds or alters: an MCP tool, an API endpoint, a blueprint, a workflow, or any user-facing feature. The CI workflow .github/workflows/docs-drift.yml also nudges PRs that change these paths without touching docs/**.

Playbook

  1. Identify the surface that changed and map it to its doc(s) using the table above.

  2. Regenerate generated docs if you touched a generated surface (e.g. MCP tools):

    node scripts/gen-docs.mjs          # writes docs/reference/mcp-tools.md
    node scripts/gen-docs.mjs --check  # verify in sync (what CI runs)
    

    Never hand-edit a generated file — edit the source attribute/route and regenerate.

Read the full file on GitHub · 71 lines

Changes

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.

  1. 3d ago First seen · 71 lines · 40 tokens per session scan A 59fa81a733b1

Subscribe to this mod's changes

agentweaver-docs-sync is a skill published in the GitHub repository sabbour/agentweaver (5 stars, last pushed 3d ago), licensed MIT. It adds 40 tokens to every session and 999 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-31.

Related

Other skills, from other repositories

auditing-kubernetes-cluster-rbac

Auditing Kubernetes cluster RBAC configurations to identify overly permissive roles, wildcard permissions, dangerous ClusterRoleBindings, service account abuse, and privilege escalation paths using kubectl, rbac-tool, KubiScan, and Kubeaudit.

xalgorix/xalgorix · 56 tokens

agent-workflow-playbook

AI Agent Workflow & Skill Architecture Guide — turn expert work into measurable, reusable agent systems. Covers workflow discovery, skill decomposition, harness design, evaluation, human escalation, observability, cost control, and multi-agent orchestration. Includes a measured marketing-delivery case: 15 people × 3–4…

Gingiris-1031/gingiris-skills · 83 tokens

dotnet-microsoft-agent-framework

Build .NET AI agents and multi-agent workflows with Microsoft Agent Framework using the right agent type, threads, tools, workflows, hosting protocols, and enterprise guardrails.

managedcode/dotPilot · 40 tokens

dotnet-microsoft-extensions-ai

Build provider-agnostic .NET AI integrations with Microsoft.Extensions.AI, IChatClient, embeddings, middleware, structured output, vector search, and evaluation.

managedcode/dotPilot · 42 tokens

dotnet-orleans

Build or review distributed .NET applications with Orleans grains, silos, persistence, streaming, reminders, placement, testing, and cloud-native hosting.

managedcode/dotPilot · 34 tokens

mcaf-dotnet

Primary entry skill for C# and .NET tasks. Detect the repo's language version, test runner, quality stack, and architecture rules; route to the right .NET subskills; and run the repo-defined post-change quality pass after any code change. Use when the user asks to implement, debug, review, or refactor .NET code, or…

managedcode/dotPilot · 87 tokens