yfinance-mcp: Instructions file for Codex

AGENTS.md

yfinance-mcp AGENTS.md is an instructions file for Codex, OpenCode from narumiruna/yfinance-mcp. It costs 633 tokens per session, scanned A, original, MIT.

Repository instructions for yfinance-mcp, an MCP server that provides financial market information through the yfinance Python library. It exposes tools for ticker data, news, prices, financial statements, holders, options, screening, and charts.

In plain words
What is it for?
Use them to develop or test tools that search market data, inspect companies, retrieve price history and financials, analyze options, or generate charts.
Why use it?
They show where each market-data function belongs and how to maintain consistent types, error responses, asynchronous behavior, and tests.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md.

This is narumiruna/yfinance-mcp's own configuration. It tells Codex and OpenCode how to work on yfinance-mcp 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 yfinance-mcp configures →

Reuse

Borrowing it

Nothing to install: this file belongs to narumiruna/yfinance-mcp. 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/narumiruna/yfinance-mcp/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/narumiruna/yfinance-mcp

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 yfinance-mcp AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/narumiruna/yfinance-mcp/agents-md.svg)](https://agentmods.dev/instructions/narumiruna/yfinance-mcp/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/narumiruna/yfinance-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/narumiruna/yfinance-mcp/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 633 This file is loaded in full into every session.
When invoked 633 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.00633 $0.00633
Opus 5 $0.00316 $0.00316
Sonnet 5 $0.00127 $0.00127
Haiku 4.5 $0.00063 $0.00063

Measured 8d ago against content hash 269775c63d36, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-08, from the pricing page.

Security

Grade A, and why

yfinance-mcp 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 8d 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 · 42 lines

How it starts

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

Repository Guidelines

Project Structure & Module Organization

  • src/yfmcp/server.py: FastMCP server, tool registration, and async wrappers around yfinance calls.
  • src/yfmcp/chart.py: chart generation (price_volume, vwap, volume_profile) and WebP image encoding.
  • src/yfmcp/types.py: shared Literal types (SearchType, TopType, Period, Interval, ChartType, ErrorCode).
  • src/yfmcp/utils.py: JSON helpers, including create_error_response().
  • tests/: async pytest suite for server tools, charts, and type behavior.
  • README.md: end-user setup and usage guide. Demo chatbot link points to the dedicated yfinance-mcp-demo repository.

Architecture Overview

  • MCP tools are exposed from yfmcp.server with yfinance_-prefixed names: yfinance_get_ticker_info, yfinance_get_analyst_price_targets, yfinance_get_analyst_estimates, yfinance_get_upgrades_downgrades, yfinance_get_fund_data, yfinance_get_ticker_news, yfinance_search, yfinance_get_top, yfinance_screen, yfinance_get_price_history, yfinance_get_financials, yfinance_get_holders, yfinance_get_option_chain, yfinance_get_option_dates.
  • All blocking yfinance operations MUST be wrapped with asyncio.to_thread().
  • Errors MUST be returned via create_error_response() with structured JSON (error, error_code, optional details).
  • Chart responses are returned as base64-encoded WebP ImageContent; tabular history uses Markdown tables.

Build, Test, and Development Commands

  • uv sync: install runtime dependencies.
  • uv sync --extra dev: install development dependencies.
  • uv run yfmcp: run the MCP server.
  • uv run ruff check . and uv run ruff format .: lint/format.
  • uv run ty check src tests: type check.
  • uv run pytest -v -s --cov=src tests: full test run with coverage.

Coding Style & Testing Guidelines

  • Python >=3.12, line length 120, one import per line (ruff isort).
  • Test files: tests/test_*.py; test functions: test_*.
  • Use pytest + pytest-asyncio for async behavior.
  • If .pre-commit-config.yaml exists and code/config changed, run prek run -a (fallback: pre-commit run -a).

Read the full file on GitHub · 42 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. 8d ago First seen · 42 lines · 633 tokens per session scan A 269775c63d36

Subscribe to this mod's changes

yfinance-mcp AGENTS.md is an instructions file published in the GitHub repository narumiruna/yfinance-mcp (190 stars, last pushed yesterday), licensed MIT. It adds 633 tokens to every session, about $0.0032 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.

Related

Other instructions, from other repositories

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens