writing-docs

writing-docs is a cursor rule for Cursor from VRSEN/agency-swarm. It costs 1,217 tokens per session, scanned A, original, MIT.

Writing rules for Agency Swarm documentation, where Agency Swarm is a framework for building groups of cooperating agents.

In plain words
What is it for?
Use them to write or revise guides, code examples, release notes, and other Agency Swarm documentation.
Why use it?
They keep technical instructions clear and actionable for readers who need to complete a task, while limiting unnecessary detail.

Cursor rule for Cursor

About the project

Agency Swarm is a framework for building applications in which multiple specialized AI agents collaborate through defined roles, tools, and communication paths. Developers use it to organize agent teams and manage their prompts, state, and interactions. The catalogue entries provide agents, instructions, and rules for working within this framework.

VRSEN/agency-swarm · 4,551 stars · on GitHub · agency-swarm.ai

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 rules/vrsen/agency-swarm/writing-docs
Clone the repo
git clone --depth 1 https://github.com/VRSEN/agency-swarm

Made for: Cursor.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for writing-docs

README.md
[![agentmods](https://agentmods.dev/badge/rules/vrsen/agency-swarm/writing-docs.svg)](https://agentmods.dev/rules/vrsen/agency-swarm/writing-docs)
Your own site
<a href="https://agentmods.dev/rules/vrsen/agency-swarm/writing-docs"><img src="https://agentmods.dev/badge/rules/vrsen/agency-swarm/writing-docs.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,217 This file is loaded in full into every session.
When invoked 1,217 The same file — it is already loaded in full.
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.1 $0.01217 $0.01217
Opus 5 $0.00609 $0.00609
Sonnet 5 $0.00243 $0.00243
Haiku 4.5 $0.00122 $0.00122

Measured 6d ago against content hash 3f47f3e8e915, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-05, from the pricing page.

Security

Grade A, and why

writing-docs 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 6d 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.

.cursor/rules/writing-docs.mdc · 154 lines

How it starts

The opening of the file, as written. The whole thing — 154 lines — stays where its author put it; the contents beside it link to each section on GitHub.

When writing or improving documentation for Agency Swarm, your primary goal is clarity for the target reader: show the information they need to complete the task, with enough context to avoid confusion.

Agency Swarm Documentation Writing Rules

  • Write documentation in an easy to understand conversational language.
  • Use simple language and clear terms.
  • Docs should be easily readable by an 8th grader.
  • Be concise, but keep full sentences and transitions when they are needed for readability.
  • Make documentation actionable. Place code snippets at the top so users can easily copy and paste them. Provide only essential context above the code. Move any complex or detailed explanations to the end of the page.
  • The more important the information is, the higher it should be on the page.
  • Highlight the important parts by using bold, components, etc.
  • Hide complexity under tabs, dropdowns, etc.
  • Split pages into sub pages if needed. Use ~150 visible lines as a readability target, not a hard limit. Collapsed content (for example accordions) does not count toward this target.

Release Notes

Use these rules for release notes so the intro stays readable and every claim stays tied to a shipped change.

  • Write the opening paragraph and each section intro for non-technical readers first. In one or two sentences, say what changed and why it matters in plain English.
  • Ground every phrase in a concrete change from the repo or release diff. If a phrase cannot be tied to a command, API, capability, limit, or fix, delete it.
  • Prefer plain verbs and nouns like start, open, run, set up, use, and fix.
  • Avoid vague opener words like documented, surface, workflow, path, and behavior unless the exact term is required for accuracy.
  • Keep the intro broad and easy to read, then let the bullets carry the exact commands, APIs, models, limits, PR numbers, and contributor names.
  • Group sections by reader value, not by implementation layer.
  • Do not present internal policy or agent-rule changes as public docs. If they must be included, label them as internal maintenance and keep them brief.

Read the full file on GitHub · 154 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. 6d ago First seen · 154 lines · 1,217 tokens per session scan A 3f47f3e8e915

Subscribe to this mod's changes

writing-docs is a cursor rule published in the GitHub repository VRSEN/agency-swarm (4,551 stars, last pushed 2d ago), licensed MIT. It adds 1,217 tokens to every session, about $0.0061 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.