ghost-mcp AGENTS.md

Repository instructions for the ghost-mcp project, including its Python layout, development commands, coding conventions, and testing guidance. An AGENTS.md file is a project-specific instruction file for coding agents.

In plain words
What is it for?
Use it when working on the project so changes follow its file structure, tools, naming rules, test process, and cleanup requirements.
Why use it?
It tells an agent how this repository is organized and how to install, run, format, lint, test, and validate changes.

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

Made for: Codex, OpenCode.

Per session 619 This file is loaded in full into every session.
When invoked 619 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.00619 $0.00619
Opus 5 $0.00309 $0.00309
Sonnet 5 $0.00124 $0.00124
Haiku 4.5 $0.00062 $0.00062

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

Security

Grade A, and why

ghost-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 · 20 lines

How it starts

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

Repository Guidelines

Project Structure & Module Organization

The application code lives in src/, with main.py bootstrapping the MCP server, mcp_server.py defining FastAPI routes, and services such as chroma_service.py, ghost_client.py, and indexer.py handling storage, API access, and synchronization. Shared models and settings sit in models.py and config.py. Tests reside in tests/ and mirror the runtime modules (test_api.py, test_mcp_tools.py, etc.). Supporting tooling includes the project-wide pyproject.toml, Makefile, container specs (Dockerfile, Dockerfile.dev, docker-compose.yml), and helper scripts like run.sh and validate-docker.sh. Coverage artifacts land in htmlcov/; clear it before committing.

Build, Test, and Development Commands

Install dependencies with uv sync --all-extras. Use uv run python -m src.main or ./run.sh to start the server locally. make dev installs development tooling, make format and make lint apply Ruff formatting and linting, make test runs the pytest suite with coverage, and make check executes the full formatting/lint/test pipeline. When debugging a single target, run uv run pytest tests/test_api.py -vv.

Coding Style & Naming Conventions

Target Python 3.12, four-space indentation, and the Ruff defaults configured in pyproject.toml (line length 100, double-quoted strings). Keep modules and functions snake_case, classes PascalCase, and constants upper snake_case. Add type hints everywhere—mypy runs in strict mode—plus concise docstrings for public entry points such as new MCP tools.

Testing Guidelines

Write unit tests alongside new functionality under tests/ using the test_*.py pattern. Prefer pytest fixtures for external dependencies and async tests (pytest-asyncio is already configured). Maintain coverage by running make test or uv run pytest --cov=src --cov-report=term-missing; regenerate local HTML reports via pytest --cov --cov-report=html and inspect htmlcov/index.html before cleanup.

Read the full file on GitHub · 20 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 · 20 lines · 619 tokens per session scan A b03340cec025

Subscribe to this mod's changes

ghost-mcp AGENTS.md is an instructions file published in the GitHub repository philipithomas/ghost-mcp (1 stars, last pushed 6mo ago), licensed MIT. It adds 619 tokens to every session, about $0.0031 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.