black-souls-mcp: Instructions file for Codex

AGENTS.md

black-souls-mcp AGENTS.md is an instructions file for Codex, OpenCode from yk4464/black-souls-mcp. It costs 855 tokens per session, scanned A, original, MIT.

Repository instructions for Black Souls MCP, a TypeScript server that connects AI tools to the Black Souls game. It also includes an in-game Ruby component and systems for navigation, battles, save data, and persistent AI memory.

In plain words
What is it for?
Building and testing the MCP server, discovering the game and save files, launching the game, controlling navigation and battles, and storing scratch notes, goals, knowledge, and session history.
Why use it?
They keep the server and game-side component compatible by requiring shared protocol, version, action-name, and command-limit changes to stay in sync.

Instructions file for CodexOpenCode

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

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

Reuse

Borrowing it

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

README.md
[![agentmods](https://agentmods.dev/badge/instructions/yk4464/black-souls-mcp/agents-md/github.svg)](https://agentmods.dev/instructions/yk4464/black-souls-mcp/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/yk4464/black-souls-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/yk4464/black-souls-mcp/agents-md/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.

agentmods 80×15 button for black-souls-mcp AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/yk4464/black-souls-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/yk4464/black-souls-mcp/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 855 This file is loaded in full into every session.
When invoked 855 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.00855 $0.00855
Opus 5 $0.00428 $0.00428
Sonnet 5 $0.00171 $0.00171
Haiku 4.5 $0.00085 $0.00085

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

Security

Grade A, and why

black-souls-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 9d 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 · 30 lines

How it starts

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

Repository Guidelines

Project Structure & Module Organization

src/ contains the strict TypeScript MCP server: index.ts defines the public tools and stable response envelope; bridge.ts owns the versioned file protocol, snapshot validation, input queue, and runtime lifecycle; config.ts resolves environment-controlled paths; and game.ts handles game discovery, integrity and save metadata, and process launch. Compiled output goes to dist/ and should not be edited. The in-game RGSS3 component is rgss/BlackSoulsBridge.rb. Keep server/package versions, BRIDGE_PROTOCOL, action names, and command limits synchronized across the TypeScript and RGSS3 sides. memory.ts implements the persistent AI memory layers (scratchpad, long-term knowledge, goals, session log); navigation.ts and battle.ts provide high-level pathfinding, interaction, and battle helpers. Test and maintenance utilities live in scripts/; PowerShell setup, verification, rollback, and uninstall entry points remain at the repository root. Architecture and setup details live in the README files, sample configuration in examples/, and the eval runner plus scenarios in evals/ (evals/results/ stays untracked). runtime/ is local generated state and must stay untracked.

Build, Test, and Development Commands

  • npm.cmd ci installs the exact locked dependencies (Node.js 18+).
  • npm.cmd run build cleans dist/ and compiles TypeScript.
  • npm.cmd run typecheck checks types without emitting files.
  • npm.cmd run check builds, performs the MCP smoke test, and runs synthetic unit tests; run this before every PR.
  • npm.cmd test runs smoke and synthetic unit tests against the existing dist/; build first when running it directly.
  • npm.cmd start starts the compiled stdio server after a build.
  • npm.cmd run test:integration exercises a prepared local runtime and also requires a current dist/ build.
  • npm.cmd run test:live launches the game from the current dist/ build and sends real input; it may load a save, move the player, and open menus, so document its scope and result.
  • .\check.ps1 -IncludeRuntime verifies source, runtime, and Codex registration together.

Read the full file on GitHub · 30 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. 9d ago First seen · 30 lines · 855 tokens per session scan A aa72d19d915c

Subscribe to this mod's changes

black-souls-mcp AGENTS.md is an instructions file published in the GitHub repository yk4464/black-souls-mcp (2 stars, last pushed 5d ago), licensed MIT. It adds 855 tokens to every session, about $0.0043 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

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

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 3,735 tokens