Audit, generate, sync, and package repository context files for AI coding agents.
Project description
Agent Context Doctor
Audit, generate, sync, and package repository context files for AI coding agents.
agentctx helps you keep project instructions accurate across tools such as Codex, Claude Code, Gemini CLI, Cursor, and GitHub Copilot. It works locally, uses no LLM API, and has zero runtime dependencies.
Why?
AI coding agents work better when your repository has clear, current, and tool-readable instructions. Many projects now carry several context files:
AGENTS.mdCLAUDE.mdGEMINI.md.github/copilot-instructions.md.cursor/rules/HANDOFF.md
Keeping those files synchronized by hand is easy to forget. Agent Context Doctor scans your repository, reports missing or stale context, generates starter files, safely syncs generated sections, and creates handoff/context packs for the next AI coding session.
Features
- Scan repository context with a readable score and machine-readable JSON.
- Generate starter files for AGENTS.md, Claude, Gemini, Copilot, Cursor, and handoff notes.
- Safely sync generated sections without deleting user-written content outside markers, including Cursor rules.
- Create handoff summaries from local Git state.
- Package AI-ready context into
PROJECT_CONTEXT.md. - Run safe repairs with
agentctx doctor --fix. - Zero runtime dependencies; Python standard library only.
Installation
From PyPI, once published:
pip install agent-context-doctor
From source:
git clone https://github.com/lamguo/agent-context-doctor.git
cd agent-context-doctor
python -m pip install -e .
Quick start
# Audit the current repository
agentctx scan
# JSON output for scripts or CI
agentctx scan --json
agentctx scan --fail-under 80
# Generate AGENTS.md and HANDOFF.md if missing
agentctx init
# Generate all supported context files
agentctx init --all
# Sync AGENTS.md into Claude, Gemini, Copilot, and Cursor instruction files
agentctx sync --from AGENTS.md
# Check whether generated files are in sync
agentctx sync --check
# Generate a handoff file from local Git state
agentctx handoff
# Generate PROJECT_CONTEXT.md for a new AI coding session
agentctx pack
# Plan safe context repairs
agentctx doctor
# Apply safe context repairs
agentctx doctor --fix
Example scan output
Agent Context Doctor
Repository: my-project
Score: 82/100 (Good)
Found:
✅ README.md
✅ AGENTS.md
✅ tests/
Missing:
⚠️ HANDOFF.md
⚠️ GEMINI.md
Problems:
⚠️ Missing HANDOFF.md. Long AI coding sessions are easier to resume with a handoff file.
⚠️ Missing GEMINI.md.
Suggestions:
- Run: agentctx init --all
- Run: agentctx handoff
Commands
agentctx scan
Checks common AI context files, project files, referenced local paths, common test commands, and sync markers.
agentctx scan
agentctx scan --json
agentctx scan --fail-under 80
agentctx scan --root /path/to/repo
agentctx init
Creates starter templates. Existing files are skipped by default.
agentctx init
agentctx init --all
agentctx init --dry-run
agentctx init --force
agentctx sync
Copies AGENTS.md into generated sections in tool-specific files. It only replaces content between agentctx markers.
agentctx sync --from AGENTS.md
agentctx sync --to claude --to gemini
agentctx sync --to cursor
agentctx sync --dry-run
agentctx sync --check
agentctx handoff
Creates a handoff file using local Git metadata.
agentctx handoff
agentctx handoff --json
agentctx handoff --output HANDOFF.md
agentctx pack
Creates an AI-ready context package.
agentctx pack
agentctx pack --output PROJECT_CONTEXT.md
agentctx doctor
Plans or applies safe automatic repairs. Safe repairs can create missing starter files, generate HANDOFF.md, and create or refresh generated tool files from AGENTS.md. It does not delete files or overwrite user-authored content outside agentctx markers.
agentctx doctor
agentctx doctor --fix
agentctx doctor --json
Generated file safety
agentctx sync uses markers like this:
<!-- agentctx:source AGENTS.md -->
<!-- agentctx:hash abc123 -->
<!-- agentctx:begin -->
Generated content here.
<!-- agentctx:end -->
On later syncs, only the generated block is replaced. Content before or after the markers is preserved.
CI usage
- name: Check agent context
run: agentctx scan --json
- name: Ensure generated agent files are synced
run: agentctx sync --check
Development
python -m pip install -e .[dev]
pytest
agentctx scan
Roadmap
- More stale-path detection rules.
- Markdown table output option.
- Context score badge helper.
- Optional GitHub Action wrapper.
- Optional
--stdoutmode foragentctx pack.
License
MIT
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file agent_context_doctor-0.2.1.tar.gz.
File metadata
- Download URL: agent_context_doctor-0.2.1.tar.gz
- Upload date:
- Size: 23.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
90116b0cbd7247c3b8f78714ac47e0fbe20e714bb92a5413f50528475e2692ca
|
|
| MD5 |
ea3066638e5011745b7a215d4f37583e
|
|
| BLAKE2b-256 |
713b499d056cd0ceac81352a6f08c996997430353cac75224e25a84448c3e0ea
|
File details
Details for the file agent_context_doctor-0.2.1-py3-none-any.whl.
File metadata
- Download URL: agent_context_doctor-0.2.1-py3-none-any.whl
- Upload date:
- Size: 22.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4e80a14bdf22468505954fe4089dffba016b0d34457c1c75dbefe15707841844
|
|
| MD5 |
10937460b584e528b53e0915cbbb9552
|
|
| BLAKE2b-256 |
38739d300e23064572a1550c03c8d848136d6ee8c3560542666ecde36c9757a7
|