What is pykrx-mcp copilot-instructions.md?

Development instructions for pykrx-mcp, an MCP server that lets AI agents query Korean KOSPI and KOSDAQ stock-market data through the pykrx library.

Use them when developing, versioning, testing, documenting, or releasing the pykrx-mcp server and its stock-data tools.

They provide project-specific rules for architecture, versioning, logging, tool definitions, and automated releases, reducing inconsistent changes.

How sharebook-kr/pykrx-mcp configures GitHub Copilot

Reuse

Borrowing it

Nothing to install: this file belongs to sharebook-kr/pykrx-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/sharebook-kr/pykrx-mcp/main/.github/copilot-instructions.md

Clone the repo

git clone --depth 1 https://github.com/sharebook-kr/pykrx-mcp

Made for: GitHub Copilot.

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/sharebook-kr/pykrx-mcp/copilot-instructions/github.svg)](https://agentmods.dev/instructions/sharebook-kr/pykrx-mcp/copilot-instructions)

Your own site

<a href="https://agentmods.dev/instructions/sharebook-kr/pykrx-mcp/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/sharebook-kr/pykrx-mcp/copilot-instructions/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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/sharebook-kr/pykrx-mcp/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/sharebook-kr/pykrx-mcp/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 2,226 This file is loaded in full into every session.

When invoked 2,226 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.

Model	Per session	Once invoked
Fable 5.1	$0.02226	$0.02226
Opus 5.5	$0.00890	$0.00890
Sonnet 5.5	$0.00445	$0.00445
Haiku 4.5	$0.00223	$0.00223

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

Security

Grade A, and why

pykrx-mcp copilot-instructions.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 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.

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.

.github/copilot-instructions.md · 249 lines

How it starts

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

pykrx-mcp Development Guide

Project Overview

This is an MCP (Model Context Protocol) server that exposes the pykrx Korean stock market data library to AI agents like Claude Desktop. The server runs via stdio and provides tools for querying KOSPI/KOSDAQ stock data.

Architecture

Core Components:

src/pykrx_mcp/server.py: FastMCP server with tool definitions
src/pykrx_mcp/__about__.py: Single source of truth for version management
server.json: MCP official registry metadata (auto-synced with Python version)
.github/workflows/publish.yml: Fully automated dual-platform release workflow

MCP stdio Pattern:

All logging MUST go to sys.stderr (stdout is reserved for MCP protocol communication)
Tool functions are decorated with @mcp.tool() and use type hints for LLM schema generation
Resources are decorated with @mcp.resource() to provide static documentation and guides
Entry point: mcp.run() in main() function

Version Management

Single source of truth: src/pykrx_mcp/__about__.py

__version__ = "x.y.z"

Fully Automated Release Workflow

Two automated paths to release:

Path 1: Upstream pykrx Update (Fully Automated)

Trigger: repository_dispatch event from pykrx repository

What happens:

CI upgrades pykrx dependency: uv lock --upgrade-package pykrx
Bumps patch version in __about__.py (e.g., 0.1.0 → 0.1.1)
Commits: uv.lock, __about__.py
Creates git tag v0.1.1
Pushes commit and tag to main branch
Tag push triggers Path 2 (below)

Zero manual intervention required.

Path 2: Tag Push (Fully Automated)

Trigger: Git tag push matching v* pattern

What happens:

Updates server.json version to match tag
Builds Python package: uv build
Publishes to PyPI via OIDC Trusted Publishing
Creates GitHub Release with auto-generated notes
MCP Registry can consume updated server.json metadata

Works for both:

Tags created by Path 1 (automated)
Tags created manually (see below)

Read the full file on GitHub · 249 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.

2mo ago First seen · 249 lines · 2,226 tokens per session scan A d8d47c802b45

Subscribe to this mod's changes

pykrx-mcp copilot-instructions.md is an instructions file published in the GitHub repository sharebook-kr/pykrx-mcp (3 stars, last pushed 9mo ago), licensed MIT. It adds 2,226 tokens to every session, about $0.0089 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-08-31.

Finance and fintech

pykrx-mcp copilot-instructions.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
pykrx-mcp copilot-instructions.mdsharebook-kr/pykrx-mcp	Instructions file	3	9mo ago	MIT	A	2,226	GitHub Copilot
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

pykrx-mcp: Instructions file for GitHub Copilot