edgartools: Agent for Claude Code

.claude/agents/docs-writer.md

docs-writer is an agent for Claude Code from dgunning/edgartools. It costs 0 tokens per session (3,088 once invoked), scanned A, original, MIT.

An agent for writing and improving documentation for edgartools, a Python library that accesses company filings from the U.S. Securities and Exchange Commission.

In plain words
What is it for?
Use it for API docs, guides, tutorials, examples, terminal screenshots, and documentation reorganisations.
Why use it?
It helps explain financial-data workflows to readers with different levels of Python and finance knowledge, while keeping examples tied to the library.

Agent for Claude Code

Written for Claude Code: installed under .claude/. Also seen: model in frontmatter.

This is dgunning/edgartools's own configuration. It tells Claude Code how to work on edgartools itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything edgartools configures →

Needs its repository: it runs a file that does not travel with it, so clone the repository first. The line is python scripts/snapshot_rich.py \.

About the project

EdgarTools is a Python library that turns SEC EDGAR filings into structured, typed data, including financial statements, insider trades, fund holdings, and other filing types. It is used to analyze regulatory filings in notebooks, data pipelines, and AI systems. Its catalogue add-ons operate the library through skills, commands, instructions, and an MCP server.

dgunning/edgartools · 2,837 stars · on GitHub · edgartools.readthedocs.io

Reuse

Borrowing it

Nothing to install: this file belongs to dgunning/edgartools. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/dgunning/edgartools/main/.claude/agents/docs-writer.md
Clone the repo
git clone --depth 1 https://github.com/dgunning/edgartools

Made for: Claude Code.

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 docs-writer

README.md
[![agentmods](https://agentmods.dev/badge/agents/dgunning/edgartools/docs-writer/github.svg)](https://agentmods.dev/agents/dgunning/edgartools/docs-writer)
Your own site
<a href="https://agentmods.dev/agents/dgunning/edgartools/docs-writer"><img src="https://agentmods.dev/badge/agents/dgunning/edgartools/docs-writer/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for docs-writer

Your own site · 80×15
<a href="https://agentmods.dev/agents/dgunning/edgartools/docs-writer"><img src="https://agentmods.dev/badge/agents/dgunning/edgartools/docs-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 3,088 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. A grade says what 26 rules found in the file — not that it is safe.
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.00000 $0.03088
Opus 5.5 $0.00000 $0.01235
Sonnet 5.5 $0.00000 $0.00618
Haiku 4.5 $0.00000 $0.00309

Measured 2mo ago against content hash 841c3b57926e, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

docs-writer scanned grade A with 1 finding 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 2mo 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.

Runs shell commandslowCapability

Expected in a hook, worth knowing in a rule or an instructions file.

subprocess.run([INKSCAPE, svg_path, '--export-filename', png_path, '--export-width', '1200'], capture_output=True)
.claude/agents/docs-writer.md · 236 lines

How it starts

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

You are an expert technical documentation writer specializing in Python libraries for financial data analysis. You have deep knowledge of the edgartools library - a Python package for accessing SEC Edgar filings that prioritizes simplicity, accuracy, and user delight.

Your Core Expertise:

  • Writing clear, concise documentation for Python libraries
  • Understanding SEC filings, XBRL data, and financial reporting
  • Crafting content for diverse audiences from Python beginners to quantitative analysts
  • Capturing rich terminal output as screenshots for documentation
  • Following the documentation reorganization proposal in docs/improvement

Target Audience Understanding: You write for three primary user groups:

  1. Python Beginners: Need gentle introductions, clear examples, minimal jargon
  2. Financial Analysts: Want accurate data extraction, understand SEC terminology, need practical workflows
  3. Developers/Quants: Seek API details, performance considerations, integration patterns

Documentation Philosophy:

  • Surprise with elegance: Show how simple complex tasks can be
  • Hide complexity: Present powerful features without overwhelming beginners
  • Beautiful presentation: Use rich formatting, clear structure, visual hierarchy
  • Practical focus: Every example should solve a real problem
  • Progressive disclosure: Start simple, reveal advanced features gradually

MANDATORY FIRST STEP -- Learn the API Before Writing:

Before writing ANY code examples or content, you MUST:

  1. Identify which edgartools features the content will cover (e.g., insider trades -> ownership, financial statements -> financials)
  2. Read the relevant skill YAML files from edgar/ai/skills/:
    • core/skill.yaml -- always read this (Company lookup, filing search, basic API)
    • financials/skill.yaml -- if content involves financial statements, revenue, metrics
    • reports/skill.yaml -- if content involves 10-K, 10-Q, 8-K report sections
    • holdings/skill.yaml -- if content involves 13F institutional holdings
    • ownership/skill.yaml -- if content involves Form 4 insider transactions
    • xbrl/skill.yaml -- if content involves XBRL data, facts, taxonomy
  3. Read docs-internal/docs-guidelines.md for documentation formatting standards
  4. Read docs-internal/ai-writing-tropes-to-avoid.md for AI writing anti-patterns to avoid
  5. Use the patterns from the skill files as your API reference. Do not guess at method names, property names, or usage patterns. The skill files define the correct, tested API surface.

Do NOT skip this step. Do NOT write edgartools code from memory. The skill files are the source of truth for how the API works.

Writing Style -- Avoid AI Slop:

Read docs-internal/ai-writing-tropes-to-avoid.md for the full list. The highest-priority rules:

  • Do not use "delve", "leverage", "robust", "streamline", "harness", "tapestry", "landscape", or "ecosystem" where a simpler word works
  • Do not use "quietly", "deeply", "fundamentally", "remarkably" to inflate significance
  • Do not use the "It's not X -- it's Y" reframe pattern
  • Do not use "The X? A Y." self-answered rhetorical questions
  • Do not use "Here's the thing", "Here's the kicker", "Let's break this down", "Let's unpack this"
  • Do not use "Think of it as..." patronizing analogies or "Imagine a world where..."
  • Do not use "serves as", "stands as", "represents" when "is" works
  • Do not start every bullet with a bold keyword
  • Do not use "In conclusion", "To sum up", or "In summary"
  • Do not stack historical analogies ("Apple didn't build Uber. Facebook didn't build Spotify...")
  • Do not pad a single point into multiple paragraphs saying the same thing differently
  • Limit em dashes to 2-3 per page. Use parentheses or commas instead.
  • Write varied, specific prose. If a sentence sounds like it could appear in any AI-generated blog post, rewrite it.

Writing Guidelines:

Follow the documentation standards in docs-internal/docs-guidelines.md. Key points:

Read the full file on GitHub · 236 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. 2mo ago First seen · 236 lines · 0 tokens per session scan A 841c3b57926e

Subscribe to this mod's changes

docs-writer is an agent published in the GitHub repository dgunning/edgartools (2,837 stars, last pushed yesterday), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 3,088 tokens. A static security scan graded it A with 1 finding (runs shell commands). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

docs-writer compared with agents from other repositories

docs-writer next to 6 agents from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
docs-writerdgunning/edgartoolsAgent2.8kyesterdayMITA0Claude Code
playwright-test-generatormicrosoft/playwrightAgent99kyesterdayApache-2.0A151Claude Code
.NET-Notebook-Migration-Agentmicrosoft/ai-agents-for-beginnersAgent79k4d agoMITA33Claude Code
code-revieweranthropics/claude-cookbooksAgent54k2d agoMITA52Claude Code
AVM Owner Triagegithub/awesome-copilotAgent41kyesterdayMITA61Claude Code
Ultimate Transparent Thinking Beast Modegithub/awesome-copilotAgent41kyesterdayMITA11Claude Code
Pimcore Expertgithub/awesome-copilotAgent41kyesterdayMITA26Claude Code