lorekeeper-mcp AGENTS.md

Project instructions for AI assistants working on the LoreKeeper MCP codebase, including when to read OpenSpec planning rules and which commands and coding conventions to follow.

In plain words
What is it for?
Use them when modifying LoreKeeper MCP, especially for proposals or major changes, and when running its tests, linter, formatter, or type checker.
Why use it?
They give agents the repository-specific rules needed to plan changes, run checks, format code, and match the project's style.

Instructions file for CodexOpenCode

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/frap129/lorekeeper-mcp/agents-md
Clone the repo
git clone --depth 1 https://github.com/frap129/lorekeeper-mcp

Made for: Codex, OpenCode.

Per session 584 This file is loaded in full into every session.
When invoked 584 The same file — it is already loaded in full.
Security scan A 0 findings. 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.00584 $0.00584
Opus 5 $0.00292 $0.00292
Sonnet 5 $0.00117 $0.00117
Haiku 4.5 $0.00058 $0.00058

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

Security

Grade A, and why

lorekeeper-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 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.

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 · 54 lines

How it starts

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

OpenSpec Instructions

These instructions are for AI assistants working in this project.

Always open @/openspec/AGENTS.md when the request:

  • Mentions planning or proposals (words like proposal, spec, change, plan)
  • Introduces new capabilities, breaking changes, architecture shifts, or big performance/security work
  • Sounds ambiguous and you need the authoritative spec before coding

Use @/openspec/AGENTS.md to learn:

  • How to create and apply change proposals
  • Spec format and conventions
  • Project structure and guidelines

Keep this managed block so 'openspec update' can refresh the instructions.

Agent Guidelines for LoreKeeper MCP

Commands

  • Run all tests: just test
  • Run single test file: uv run pytest tests/test_cache/test_db.py
  • Run single test: uv run pytest tests/test_cache/test_db.py::test_function_name
  • Lint: just lint
  • Format: just format
  • Type check: just type-check
  • All quality checks: just check

Code Style

  • Line length: 100 characters max
  • Python version: 3.11+
  • Type hints: Required on all functions (strict mypy). Use dict[str, Any], list[Type], Type | None (no Optional)
  • Imports: Standard library → third-party → local (ruff handles sorting)
  • Quotes: Double quotes
  • Indentation: 4 spaces
  • Async: Use async def for all I/O operations; tests use @pytest.mark.asyncio or rely on asyncio_mode = "auto"

Conventions

  • Naming: snake_case for functions/variables, PascalCase for classes, UPPER_CASE for constants
  • Docstrings: Google style with Args, Returns, Raises sections on public functions
  • Error handling: Use custom exceptions (ApiError, NetworkError), log warnings for non-fatal errors
  • Logging: logger = logging.getLogger(__name__) at module level, use logger.debug/info/warning/error
  • Testing: Fixtures in conftest.py, use respx.mock for HTTP mocking, prefer async fixtures with yield

Read the full file on GitHub · 54 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 · 54 lines · 584 tokens per session scan A a7129de390d0

Subscribe to this mod's changes

lorekeeper-mcp AGENTS.md is an instructions file published in the GitHub repository frap129/lorekeeper-mcp (2 stars, last pushed 1mo ago), licensed MIT. It adds 584 tokens to every session, about $0.0029 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-31.

Related

Other instructions, from other repositories

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

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

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