easy-code-reader copilot-instructions.md

A project guide for Easy Code Reader, an MCP server that extracts Java source code from Maven dependencies and local projects. Maven is a Java build system and repository for sharing libraries.

In plain words
What is it for?
Use it to read Java code from JAR files, inspect local projects, list project files, select a decompiler, and understand Maven repository settings and caching.
Why use it?
Java dependencies often contain compiled files rather than directly readable source code. The guide explains how the project locates those files and chooses available source or decompilation methods.

Instructions file for GitHub Copilot

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/fangyuan33/easy-code-reader/copilot-instructions
Clone the repo
git clone --depth 1 https://github.com/FangYuan33/easy-code-reader

Made for: GitHub Copilot.

Per session 1,984 This file is loaded in full into every session.
When invoked 1,984 The same file — it is already loaded in full.
Security scan A 1 finding. Scan, not verified.
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 $0.01984 $0.01984
Opus 5 $0.00992 $0.00992
Sonnet 5 $0.00397 $0.00397
Haiku 4.5 $0.00198 $0.00198

Measured 2d ago against content hash fc3d42e04f46, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

easy-code-reader copilot-instructions.md scanned grade A with 1 finding 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 2d 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.

Runs shell commandslowCapability

Expected in a hook, worth knowing in a rule or an instructions file.

- Java: Must be in PATH for `subprocess.run(['java', '-jar', ...])` calls
.github/copilot-instructions.md · 162 lines

How it starts

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

Copilot Instructions for Easy Code Reader

This guide helps AI coding agents work productively in the Easy Code Reader codebase. It summarizes architecture, workflows, conventions, and integration points unique to this project.

Architecture Overview

Purpose: MCP (Model Context Protocol) server that extracts Java source code from Maven dependencies and local projects.

Core Components:

  • src/easy_code_reader/server.py: MCP server implementation (4 tools: read_jar_source, read_project_code, list_all_project, list_project_files)
  • decompiler.py: Auto-selects CFR (Java 8-20) or Fernflower (Java 21+) based on _detect_java_version()
  • config.py: Maven repo path resolution via MAVEN_HOME, M2_HOME, or MAVEN_REPO env vars
  • decompilers/: Bundled fernflower.jar and cfr.jar via setuptools package_data

Data Flow:

  1. MCP request → server.py tool handler (_read_jar_source or project tools)
  2. Maven path lookup: group.id/artifact/version/artifact-version.jar (handles SNAPSHOT timestamps)
  3. Source extraction priority: sources JAR → decompilation → fallback class info
  4. Decompilation cache: {jar_dir}/easy-code-reader/{jar_name}/ (cleaned for SNAPSHOT updates)
  5. Return JSON response with class/file code

SNAPSHOT Handling: For -SNAPSHOT versions, searches for timestamped JARs (e.g., artifact-1.0.0-20251030.085053-1.jar) for decompilation but caches under timestamped name. Old SNAPSHOT caches auto-deleted via _cleanup_old_snapshot_cache when newer timestamps detected.

Developer Workflows

Run Service:

# Recommended (if published to PyPI)
uvx easy-code-reader [--maven-repo PATH] [--project-dir PATH]

# Development mode
python -m easy_code_reader [--maven-repo PATH] [--project-dir PATH]

Testing:

pytest tests/                     # All tests
pytest tests/test_jar_reader.py -v  # Specific test file

Development Install:

pip install -e .           # Editable install
pip install -e ".[dev]"    # With dev dependencies (pytest, build, twine)

Read the full file on GitHub · 162 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. 2d ago First seen · 162 lines · 1,984 tokens per session scan A fc3d42e04f46

Subscribe to this mod's changes

easy-code-reader copilot-instructions.md is an instructions file published in the GitHub repository FangYuan33/easy-code-reader (155 stars, last pushed 6mo ago), licensed Apache-2.0. It adds 1,984 tokens to every session, about $0.0099 per session on Opus 5. A static security scan graded it A with 1 finding (runs shell commands). 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

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

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,182 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

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,345 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

next.js 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