* docs(extensions): clarify agent-context README and add config examples Rewrite the agent-context extension README to read as plain prose instead of a bullet dump, and add the missing install/disable commands (specify extension add/disable/enable agent-context). Add inline example comments to agent-context-config.yml for context_file/context_files. * docs(agent-context): clarify config documentation - Reformat comments to flow as single-line paragraphs instead of multi-line breaks - Add "WHAT" sections describing each configuration option's purpose - Add "REQUIREMENT" sections specifying if options are optional or required - Add explicit EXAMPLE sections for context_markers configuration - Improve clarity of context_file and context_files option descriptions * docs(agent-context): fix GitHub casing, clarify config - Fix "Github" -> "GitHub" casing in README issues link - Clarify agent-context-config.yml comments on context_file/context_files behavior and precedence * YAML indentation fix for context markers Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * docs(agent-context): simplify README config section - Clarify config file path reference (.specify/extensions path vs repo path) - Remove duplicated YAML example/field docs from README, point to config file directly - Minor spacing fix in agent-context-config.yml comment * docs(agent-context): clarify config file path in README - Reference the installed .specify config path alongside the repo-relative link * docs(agent-context): clarify install and marker requirement - README: clarify install command must be run from an initialized Spec Kit project root - config: correct context_markers requirement from REQUIRED to OPTIONAL * Wording Fix Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * docs(agent-context): clarify context_file path rules - Document that context_file/context_files are relative to the project root (directory containing .specify/) - State the rejected path forms (absolute paths, backslash separators, .. segments) directly in each field's WHAT comment * Updated supported invocation syntaxes Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * Extension Disable Clarification Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * docs(agent-context): document .mdc frontmatter exception - Clarify that .mdc files get alwaysApply: true set in frontmatter, outside the managed marker block - Fix "Everything else is untouched" wording so it doesn't contradict the exception right above it --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Coding Agent Context Extension
This bundled extension manages the coding agent context/instruction file (e.g. CLAUDE.md, .github/copilot-instructions.md, AGENTS.md, GEMINI.md, …) for the active integration.
It owns the lifecycle of the managed section delimited by the configurable start/end markers (defaults: <!-- SPECKIT START --> / <!-- SPECKIT END -->). For .mdc files, it also ensures the YAML frontmatter (the metadata block at the top of the file) contains alwaysApply: true. Otherwise, everything outside the managed section is untouched.
NOTE: Spec Kit itself never touches your agent context file. This extension is the only thing that does, and it's opt-in: install it if you want the block kept in sync, skip it if you'd rather manage that file yourself.
Why an extension?
Not every Spec Kit user wants Spec Kit to write into the coding agent's context file. Keeping this behavior in a dedicated, opt-in extension lets users:
- Choose whether to install it at all -
specify initdoes not install it. Add it explicitly when you want Spec Kit to manage the agent context file; when it is absent, the file is never modified, and when it is disabled, its automatic hooks do not run. - Customize the markers by editing
.specify/extensions/agent-context/agent-context-config.yml(agent-context-config.yml in this repo) - the bundled scripts honor thecontext_markersvalue. - Synchronize multiple agent anchors by setting
context_fileswhen a project intentionally uses more than one coding agent context file, such asAGENTS.mdandCLAUDE.md. - Refresh on demand by running the
speckit.agent-context.updatecommand in your agent, or automatically through the hooks declared in extension.yml (after_specify,after_plan).
Installation
To install the extension, from the root of an initialized Spec Kit project, run:
specify extension add agent-context
Disabling
specify extension disable agent-context
# Re-enable it
specify extension enable agent-context
While this extension is disabled (or not installed), nothing in Spec Kit creates, updates, or removes the managed block - the __CONTEXT_FILE__ placeholder in any template is left as-is, and the extension's own config is never read.
Commands
| Command | Description |
|---|---|
speckit.agent-context.update |
Refresh the managed section in the agent context file with the current plan path. |
NOTE: The command ID above is canonical. Invoke it using the syntax for your integration:
/speckit.agent-context.updatefor dot-command integrations;/speckit-agent-context-updatefor hyphen/skills integrations (including Forge and Cline);$speckit-agent-context-updatefor Codex or ZCode in skills mode; or/skill:speckit-agent-context-updatefor Kimi.
Configuration
All configuration flows through the extension's own config file at .specify/extensions/agent-context/agent-context-config.yml (agent-context-config.yml in the repo).
Requirements
The bundled update scripts require Python 3 with PyYAML for YAML/upsert processing (PowerShell can also use ConvertFrom-Yaml when available).
PyYAML ships with the specify CLI and is normally available via the same python3 interpreter. If a hook reports "PyYAML is required … not available in the current Python environment", it means the system python3 differs from the one used to install Spec Kit. To resolve, run:
pip install pyyaml
# or target the specific interpreter Spec Kit uses:
/path/to/speckit-python -m pip install pyyaml
Issues
For any other issues, please create an issue in the official GitHub repo.