agentmods.dev

edgartools: Instructions file for Codex

AGENTS.md

edgartools AGENTS.md is an instructions file for Codex, OpenCode from dgunning/edgartools. It costs 1,275 tokens per session, scanned A, original, MIT.

Repository instructions for AI coding agents working on the edgartools Python project. They document setup commands, required SEC request identity, important source locations, and testing rules.

In plain words
What is it for?
Use them when installing the project, finding filing or XBRL code, running offline or network tests, checking lint, or preparing changes for review.
Why use it?
They provide project facts that cannot be safely inferred from code alone, such as the package/import name difference and network-test limits. This reduces setup mistakes and inappropriate test runs.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions Claude Code; mentions AGENTS.md; mentions Codex.

This is dgunning/edgartools's own configuration. It tells Codex and OpenCode 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 →

not rated 2.8krepo +6 changed 14d ago A scan 1,275 tokens original MIT
View source ↗ dgunning/edgartools edgartools.readthedocs.io
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/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/dgunning/edgartools

Made for: Codex, OpenCode.

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 edgartools AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/dgunning/edgartools/agents-md/github.svg)](https://agentmods.dev/instructions/dgunning/edgartools/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/dgunning/edgartools/agents-md"><img src="https://agentmods.dev/badge/instructions/dgunning/edgartools/agents-md/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 edgartools AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/dgunning/edgartools/agents-md"><img src="https://agentmods.dev/badge/instructions/dgunning/edgartools/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,275 This file is loaded in full into every session.
When invoked 1,275 The same file — it is already loaded in full.
Security scan A 0 findings. 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.01275 $0.01275
Opus 5.5 $0.00510 $0.00510
Sonnet 5.5 $0.00255 $0.00255
Haiku 4.5 $0.00128 $0.00128

Measured 14d ago against content hash 708faa307cad, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

edgartools AGENTS.md 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 14d 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.

AGENTS.md · 83 lines

How it starts

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

AGENTS.md

Instructions for AI coding agents working on this repository (Claude Code, Codex, Cursor, Copilot, Gemini CLI and others). People should start with CONTRIBUTING.md. Everything here applies to them too.

Setup and commands

  • Python 3.11+, managed with Hatch: hatch shell.
  • The package installs as edgartools but imports as edgar (from edgar import Company).
  • SEC requires a contact identity on every request: export EDGAR_IDENTITY="Your Name [email protected]".
hatch run test-fast                       # offline tests: run these often
hatch run lint                            # ruff
hatch run test-network tests/path/test_x.py   # network tests: one file at a time, never in parallel (SEC allows 10 req/s)
hatch run check-cassettes                 # before running tests on a branch you did not write
hatch run check-regression-provenance     # CI runs this before tests

Where things are

Area Location
Filing, Filings edgar/_filings.py
Company, Entity edgar/entity/
XBRL, statements edgar/xbrl/
HTML parsing, sections, markdown edgar/documents/ (the only HTML parser; edgar.files was removed in 6.0)
10-K / 10-Q / 8-K objects edgar/company_reports/
Form 3/4/5, 13F, funds edgar/ownership/, edgar/thirteenf/, edgar/funds/
Full-text search edgar/search/efts.py
Form → class routing for filing.obj() the obj() chain in edgar/__init__.py
MCP server and bundled skills edgar/ai/

Things you cannot infer from the code

  • edgar/xbrl/standardization/gaap_mappings.json is generated outside this repo. Keep edits to the concepts in your issue, add a regression test, and check that no other open PR touches it (see below).
  • Concept-mapping bugs usually need fixing twice: once in the XBRL standardization and once in EntityFacts (edgar/entity/).
  • The Filing.text(), Filing.html() and Attachment.empty contracts are frozen. Fix text extraction in FilingSGML or edgar/documents, never by rerouting Filing.*.
  • Test cassettes are recorded from live SEC, against main, and never edited afterwards (CONTRIBUTING.md, "Test Cassettes").
  • Never edit CHANGELOG.md. Add a fragment instead: changelog.d/<issue>.<section>.md (see changelog.d/README.md).
  • A deprecation or breaking change needs an entry in docs/upgrade/6.0.md. CI fails the PR without one.

Read the full file on GitHub · 83 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. 14d ago Changed · +4 lines · +121 tokens per session 708faa307cad
  2. 22d ago First seen · 79 lines · 1,154 tokens per session scan A febe474ea159

Subscribe to this mod's changes

edgartools AGENTS.md is an instructions file published in the GitHub repository dgunning/edgartools (2,837 stars, last pushed yesterday), licensed MIT. It adds 1,275 tokens to every session, about $0.0051 per session on Opus 5.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-10-16.

10-k10-qBuilding agentsLanguagesPythonbalance-sheetedgarfilingsfinancials
Related

edgartools AGENTS.md compared with instructions from other repositories

edgartools AGENTS.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
edgartools AGENTS.mddgunning/edgartoolsInstructions file2.8kyesterdayMITA1,275Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143ktodayMITA7,461Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA5,516GitHub Copilot
langchain AGENTS.mdlangchain-ai/langchainInstructions file149ktodayMITA4,680Codex, OpenCode
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode