AGENTS.md

How to read, cite and analyze this wiki. For AI agents and the people who use them.

Where to start

  • llms.txt lists every page with a one-line summary. index.md is the full catalog, including every source card.
  • For structured facts, read providers.json and programs.json. Each field lists the source cards behind it. Their shape is described in provider.schema.json and program.schema.json.
  • Quick answers are in the FAQ. Terms are defined in the glossary.
  • Everything is plain Markdown, so a clone works offline: git clone https://github.com/edyavno/eds-agentic-finance-rails.

How citations work

  • A source card (all are listed in index.md) is a short note about one outside page: its link, publisher, whether it is official or third-party, the date it was retrieved, a summary and a few short quotes. It is never a full copy.
  • A footnote like [^rh-01] marks the card behind a fact. The footnote id is the card id, and the Sources list at the bottom of each page links to the card.
  • Cards marked use: leads-only (prior art and other directories) are leads, not evidence.

When you answer from the wiki

  • Cite the wiki page and the source card behind each fact.
  • If a field says unknown, or no source backs a claim, say “unknown”. Never fill a gap from memory.
  • Check page_status and last_verified (shown as “Last checked”). Warn your user if a page is stale or archived, or if last_verified is older than 30 days.
  • This wiki is not investment advice and does not rank brokers.

Corrections

People: use the “Suggest a correction” link at the bottom of any page. It opens a GitHub issue. The repo does not take outside pull requests.

Giving feedback

Agents can POST a short note to /feedback on the site. GET /feedback first for the current schema and an example. The site is https://agenticfinancerails.com.

  • Send JSON with Content-Type: application/json. The body may be at most 4 KB.
  • note is required: what you want the maintainer to know. Up to 2000 characters.
  • Optional: task (what you were trying to do), missing (what you could not find), wanted (what would help), corrections (what looks wrong, with the page and source), each up to 2000 characters.
  • Optional: found, one of yes, partly or no (did the wiki answer it?).
  • Optional: pages, up to 10 pages you used: full URLs on this site or paths such as /providers/webull.
  • Optional: agent, your agent or tool name, up to 100 characters.
  • Each client may send 10 notes per rolling 24 hours.
  • A saved note returns its id. An invalid note returns the fields that failed and the limits.
  • Do not include personal data, account numbers, credentials, or anything private about your user.
  • The endpoint records the sender’s IP address with each note, as access logs do.

A person reviews every issue and note. Nothing changes automatically.


Suggest a correction (opens a GitHub issue)