agentleFS
Sign inStart free
CyranoBCyranoB/web-forager/AGENTS.md

web-forager

AGENTS.md10 starsChanged 56 days agoMITView on GitHub

Web Forager provides web search, news search, and URL fetching for AI agents. It exposes the capabilities through a FastMCP STDIO server and a CLI, and packages agent workflows under skills/. Search and news use ddgs. Fetching tries direct HTTP with trafilatura, then falls back to Jina Reader. - Read the relevant implementation and tests before editing. - Keep changes focused and consistent with existing patterns. - Treat src/web_forager/_version.py as generated by setuptools_scm. - For skill, plugin, or release changes,…

  • Installs packages
  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,774 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository8 other files it gives its agents.

The file

We split this AGENTS.md into the rules it gives an agent

9 rules. About 1 is common, 5 are distinctive, and 3 are very specific to this project.

  • ≈1

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Search and news use ddgs. Fetching tries direct HTTP with trafilatura, then falls back to Jina Reader.

    line 9
  2. Distinctive:

    Read the relevant implementation and tests before editing.

    line 14
  3. Distinctive:

    Keep changes focused and consistent with existing patterns.

    line 15
  4. Very specific:

    Treat src/web_forager/_version.py as generated by setuptools_scm.

    line 16
  5. Distinctive:

    When CLI flags or MCP tool behavior changes, update the corresponding tests and README.md documentation in the same change.

    line 19
  6. Common:

    Keep credentials and other secrets out of source, configuration, fixtures, logs, and documentation.

    line 21
  7. Distinctive:

    Run the narrowest relevant test first, then use the full checks when the change can affect multiple components:

    line 32
  8. Distinctive:

    Use the CLI smoke tests documented in README.md when changing search, news, fetch, or CLI behavior.

    line 42
  9. Very specific:

    Before editing README prose or structure, read docs/agents/readme-style.md.

    line 47

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Repository guidance

Purpose

Web Forager provides web search, news search, and URL fetching for AI agents. It exposes the capabilities through a FastMCP STDIO server and a CLI, and packages agent workflows under skills/.

Search and news use ddgs. Fetching tries direct HTTP with trafilatura, then falls back to Jina Reader.

Change contract

  • Read the relevant implementation and tests before editing.
  • Keep changes focused and consistent with existing patterns.
  • Treat src/web_forager/_version.py as generated by setuptools_scm.
  • For skill, plugin, or release changes, follow docs/versioning.md. Bump the shared plugin version in the same PR as a skill change.
  • When CLI flags or MCP tool behavior changes, update the corresponding tests and README.md documentation in the same change.
  • Keep credentials and other secrets out of source, configuration, fixtures, logs, and documentation.

Development

Install the development dependencies:

uv pip install -e ".[dev]"

Run the narrowest relevant test first, then use the full checks when the change can affect multiple components:

pytest
mypy src
black --check src
isort --check-only src

Use the CLI smoke tests documented in README.md when changing search, news, fetch, or CLI behavior.

Agent workflow references

  • Before editing README prose or structure, read docs/agents/readme-style.md.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free