-
Notifications
You must be signed in to change notification settings - Fork 9.5k
Extract agent context updates into bundled agent-context extension #2546
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
29 commits
Select commit
Hold shift + click to select a range
1d6c160
Initial plan
Copilot cca1825
Extract agent context updates into bundled agent-context extension
Copilot d79fd51
Potential fix for pull request finding 'Unused import'
mnriem 8e0d40e
Potential fix for pull request finding 'Unused import'
mnriem 8512915
fix: address review comments on agent-context extension
Copilot 7bc560e
fix: gate context_markers in _update_init_options_for_integration on …
Copilot 1759d8d
fix: move context_file/context_markers from init-options.json to agen…
Copilot c7c9812
Potential fix for pull request finding 'Unused global variable'
mnriem 2e822be
fix: clarify local import comment in agents.py
Copilot 84df982
Fix remaining agent-context review findings
Copilot 22d6ef5
Fix follow-up agent-context review issues
Copilot f0b5b0b
Address review feedback: narrow except, improve PyYAML messaging, sur…
Copilot 019c263
Fix double-space in PyYAML install hint message
Copilot 404ba4d
Potential fix for pull request finding 'Empty except'
mnriem d4a1754
Potential fix for pull request finding 'Empty except'
mnriem 8073e08
Address latest agent-context review feedback
Copilot 765afb2
Harden bash config parse output handling
Copilot b848b62
Clarify ImportError-only fallback comment
Copilot 2849e6d
Apply review feedback: drop dead try/except, guard ext-config creatio…
Copilot 7402f3d
Remove redundant $Options = $null in PS1 catch block
Copilot cf59d86
Merge remote-tracking branch 'upstream/main' into HEAD
mnriem 2c55eab
Add constitution directives, deprecation warning, agent-context auto-…
mnriem f76c6f8
Address review: fix init ordering, test coverage, and hermes inventory
mnriem 38e03e2
Address review: chmod ordering, preserve markers, PS1 Python check, Y…
mnriem 7624efe
Address review: path traversal guards and docstring fix
mnriem 5d9cc7c
Address review: strict enabled check, docstring, segment-level path t…
mnriem df18341
Address review: UnicodeError handling, missing extension warning
mnriem f190123
Address review: bash backslash traversal guard, wheel packaging
mnriem ca5f2f8
Address review: write extension config before init-options.json
mnriem File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # 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 -->`). | ||
|
|
||
| ## Why an extension? | ||
|
|
||
| Not every Spec Kit user wants Spec Kit to write into the coding agent's context file. Extracting this behavior into a dedicated extension lets users: | ||
|
|
||
| - **Opt out** entirely with `specify extension disable agent-context` — Spec Kit will then never create or modify the agent context file. | ||
| - **Customize the markers** by editing `.specify/extensions/agent-context/agent-context-config.yml` — both the Python layer and the bundled scripts honor the same `context_markers` value. | ||
| - **Refresh on demand** with `/speckit.agent-context.update`, or automatically through the hooks declared in `extension.yml` (`after_specify`, `after_plan`). | ||
|
|
||
| ## Commands | ||
|
|
||
| | Command | Description | | ||
| |---------|-------------| | ||
| | `speckit.agent-context.update` | Refresh the managed section in the agent context file with the current plan path. | | ||
|
|
||
| ## Configuration | ||
|
|
||
| All configuration flows through the extension's own config file at | ||
| `.specify/extensions/agent-context/agent-context-config.yml`: | ||
|
|
||
| ```yaml | ||
| # Path to the coding agent context file managed by this extension | ||
| context_file: CLAUDE.md | ||
|
|
||
| # Delimiters for the managed Spec Kit section | ||
| context_markers: | ||
| start: "<!-- SPECKIT START -->" | ||
| end: "<!-- SPECKIT END -->" | ||
| ``` | ||
|
|
||
| - `context_file` — the project-relative path to the coding agent context file, written by `specify init` and `specify integration install`. | ||
| - `context_markers.start` / `.end` — the delimiters around the managed section. Edit these to use custom markers. | ||
|
|
||
| ## 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: | ||
|
|
||
| ```bash | ||
| pip install pyyaml | ||
| # or target the specific interpreter Spec Kit uses: | ||
| /path/to/speckit-python -m pip install pyyaml | ||
| ``` | ||
|
|
||
| ## Disable | ||
|
|
||
| ```bash | ||
| specify extension disable agent-context | ||
| ``` | ||
|
|
||
| When disabled, Spec Kit skips context file creation, updates, and removal (the gates are inside `upsert_context_section()` and `remove_context_section()`). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # Coding Agent Context Extension Configuration | ||
| # These values are populated automatically by `specify init` and | ||
| # `specify integration use` / `specify integration install`. | ||
|
|
||
| # Path (relative to the project root) to the coding agent context file | ||
| # managed by this extension (e.g. CLAUDE.md, AGENTS.md, | ||
| # .github/copilot-instructions.md). Set automatically from the active | ||
| # integration and regenerated during `specify init` or integration switches. | ||
| context_file: "" | ||
|
|
||
| # Delimiters for the managed Spec Kit section. | ||
| # Edit these to use custom markers. | ||
| context_markers: | ||
| start: "<!-- SPECKIT START -->" | ||
| end: "<!-- SPECKIT END -->" |
26 changes: 26 additions & 0 deletions
26
extensions/agent-context/commands/speckit.agent-context.update.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| --- | ||
| description: "Refresh the managed Spec Kit section in the coding agent context file" | ||
| --- | ||
|
|
||
| # Update Coding Agent Context | ||
|
|
||
| Refresh the managed Spec Kit section inside the active coding agent's context/instruction file (e.g. `CLAUDE.md`, `.github/copilot-instructions.md`, `AGENTS.md`). | ||
|
|
||
| ## Behavior | ||
|
|
||
| The script reads the agent-context extension config at | ||
| `.specify/extensions/agent-context/agent-context-config.yml` to discover: | ||
|
|
||
| - `context_file` — the path of the coding agent context file to manage. | ||
| - `context_markers.start` / `.end` — the delimiters surrounding the managed section. Defaults to `<!-- SPECKIT START -->` and `<!-- SPECKIT END -->` when the field is missing. | ||
|
|
||
| It then creates, replaces, or appends the managed block so that the section points at the most recent plan path when one can be discovered (`specs/<feature>/plan.md`). | ||
|
|
||
| If `context_file` is empty or the file cannot be located, the command reports nothing to do and exits successfully. | ||
|
|
||
| ## Execution | ||
|
|
||
| - **Bash**: `.specify/extensions/agent-context/scripts/bash/update-agent-context.sh [plan_path]` | ||
| - **PowerShell**: `.specify/extensions/agent-context/scripts/powershell/update-agent-context.ps1 [plan_path]` | ||
|
|
||
| When `plan_path` is omitted, the script auto-detects the most recently modified `specs/*/plan.md`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| schema_version: "1.0" | ||
|
|
||
| extension: | ||
| id: agent-context | ||
| name: "Coding Agent Context" | ||
| version: "1.0.0" | ||
| description: "Manages coding agent context/instruction files (e.g., CLAUDE.md, copilot-instructions.md) with project-specific plan references and configurable markers" | ||
| author: spec-kit-core | ||
| repository: https://github.com/github/spec-kit | ||
| license: MIT | ||
|
|
||
| requires: | ||
| speckit_version: ">=0.2.0" | ||
|
|
||
| provides: | ||
| commands: | ||
| - name: speckit.agent-context.update | ||
| file: commands/speckit.agent-context.update.md | ||
| description: "Refresh the managed Spec Kit section in the coding agent context file" | ||
|
|
||
| hooks: | ||
| after_specify: | ||
| command: speckit.agent-context.update | ||
| optional: true | ||
| description: "Refresh agent context after specification" | ||
| after_plan: | ||
| command: speckit.agent-context.update | ||
| optional: true | ||
| description: "Refresh agent context after planning" | ||
|
|
||
| tags: | ||
| - "agent" | ||
| - "context" | ||
| - "core" |
200 changes: 200 additions & 0 deletions
200
extensions/agent-context/scripts/bash/update-agent-context.sh
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| #!/usr/bin/env bash | ||
| # update-agent-context.sh | ||
| # | ||
| # Refresh the managed Spec Kit section in the coding agent's context file | ||
| # (e.g. CLAUDE.md, .github/copilot-instructions.md, AGENTS.md). | ||
| # | ||
| # Reads `context_file` and `context_markers.{start,end}` from the | ||
| # agent-context extension config: | ||
| # .specify/extensions/agent-context/agent-context-config.yml | ||
| # | ||
| # Usage: update-agent-context.sh [plan_path] | ||
| # | ||
| # When `plan_path` is omitted, the script picks the most recently modified | ||
| # `specs/*/plan.md` if any exist, otherwise emits the section without a | ||
| # concrete plan path. | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| PROJECT_ROOT="$(pwd)" | ||
| EXT_CONFIG="$PROJECT_ROOT/.specify/extensions/agent-context/agent-context-config.yml" | ||
| DEFAULT_START="<!-- SPECKIT START -->" | ||
| DEFAULT_END="<!-- SPECKIT END -->" | ||
|
|
||
| if [[ ! -f "$EXT_CONFIG" ]]; then | ||
| echo "agent-context: $EXT_CONFIG not found; nothing to do." >&2 | ||
| exit 0 | ||
| fi | ||
|
|
||
| # Locate a suitable Python interpreter (python3, then python). | ||
| _python="" | ||
| if command -v python3 >/dev/null 2>&1; then | ||
| _python="python3" | ||
| elif command -v python >/dev/null 2>&1 && python --version 2>&1 | grep -q "^Python 3"; then | ||
| _python="python" | ||
| fi | ||
|
|
||
| if [[ -z "$_python" ]]; then | ||
| echo "agent-context: Python 3 not found on PATH; skipping update." >&2 | ||
| exit 0 | ||
| fi | ||
|
|
||
| # Parse extension config once; emit three newline-separated fields: | ||
| # context_file, context_markers.start, context_markers.end | ||
| if ! _raw_opts="$("$_python" - "$EXT_CONFIG" <<'PY' | ||
| import sys | ||
| try: | ||
| import yaml | ||
| except ImportError: | ||
| print( | ||
| "agent-context: PyYAML is required to parse extension config but is not available " | ||
| "in the current Python environment.\n" | ||
| " To resolve: pip install pyyaml (or install it into the environment used by python3).\n" | ||
| " Context file will not be updated until PyYAML is importable.", | ||
| file=sys.stderr, | ||
| ) | ||
| sys.exit(2) | ||
| try: | ||
| with open(sys.argv[1], "r", encoding="utf-8") as fh: | ||
| data = yaml.safe_load(fh) | ||
| except Exception as exc: | ||
| print( | ||
| f"agent-context: unable to parse {sys.argv[1]} ({exc}); cannot update context.", | ||
| file=sys.stderr, | ||
| ) | ||
| sys.exit(2) | ||
| if not isinstance(data, dict): | ||
| data = {} | ||
| def get_str(obj, *keys): | ||
| node = obj | ||
| for k in keys: | ||
| if isinstance(node, dict) and k in node: | ||
| node = node[k] | ||
| else: | ||
| return "" | ||
| return node if isinstance(node, str) else "" | ||
| print(get_str(data, "context_file")) | ||
| print(get_str(data, "context_markers", "start")) | ||
|
mnriem marked this conversation as resolved.
|
||
| print(get_str(data, "context_markers", "end")) | ||
| PY | ||
| )"; then | ||
| echo "agent-context: skipping update (see above for details)." >&2 | ||
| exit 0 | ||
| fi | ||
|
mnriem marked this conversation as resolved.
|
||
|
|
||
| _opts_lines=() | ||
| while IFS= read -r _line || [[ -n "$_line" ]]; do | ||
| _opts_lines+=("$_line") | ||
| done < <(printf '%s\n' "$_raw_opts") | ||
| if (( ${#_opts_lines[@]} < 3 )); then | ||
| echo "agent-context: malformed config parser output; expected 3 lines (context_file, marker_start, marker_end), got ${#_opts_lines[@]}; skipping update." >&2 | ||
| exit 0 | ||
| fi | ||
| CONTEXT_FILE="${_opts_lines[0]}" | ||
| MARKER_START="${_opts_lines[1]}" | ||
| MARKER_END="${_opts_lines[2]}" | ||
|
|
||
| if [[ -z "$CONTEXT_FILE" ]]; then | ||
| echo "agent-context: context_file not set in extension config; nothing to do." >&2 | ||
| exit 0 | ||
|
mnriem marked this conversation as resolved.
|
||
| fi | ||
|
|
||
| # Reject absolute paths, backslash separators, and '..' path segments in context_file | ||
| if [[ "$CONTEXT_FILE" == /* ]] || [[ "$CONTEXT_FILE" =~ ^[A-Za-z]: ]]; then | ||
| echo "agent-context: context_file must be a project-relative path; got '$CONTEXT_FILE'." >&2 | ||
| exit 1 | ||
| fi | ||
| if [[ "$CONTEXT_FILE" == *\\* ]]; then | ||
| echo "agent-context: context_file must not contain backslash separators; got '$CONTEXT_FILE'." >&2 | ||
| exit 1 | ||
| fi | ||
| IFS='/' read -ra _cf_parts <<< "$CONTEXT_FILE" | ||
| for _seg in "${_cf_parts[@]}"; do | ||
| if [[ "$_seg" == ".." ]]; then | ||
| echo "agent-context: context_file must not contain '..' path segments; got '$CONTEXT_FILE'." >&2 | ||
| exit 1 | ||
| fi | ||
| done | ||
| unset _cf_parts _seg | ||
|
|
||
| [[ -z "$MARKER_START" ]] && MARKER_START="$DEFAULT_START" | ||
| [[ -z "$MARKER_END" ]] && MARKER_END="$DEFAULT_END" | ||
|
|
||
| PLAN_PATH="${1:-}" | ||
| if [[ -z "$PLAN_PATH" ]]; then | ||
| # Pick the most recently modified plan.md one level deep (specs/<feature>/plan.md). | ||
| # Use find + sort by modification time to avoid ls/head fragility with | ||
| # spaces in paths or SIGPIPE from pipefail. | ||
| _plan_abs="$("$_python" - "$PROJECT_ROOT" <<'PY' | ||
| import sys, os | ||
| from pathlib import Path | ||
| specs = Path(sys.argv[1]) / "specs" | ||
| plans = sorted( | ||
| specs.glob("*/plan.md"), | ||
| key=lambda p: p.stat().st_mtime, | ||
| reverse=True, | ||
| ) | ||
| print(plans[0] if plans else "") | ||
| PY | ||
| )" | ||
| if [[ -n "$_plan_abs" ]]; then | ||
| PLAN_PATH="${_plan_abs#"$PROJECT_ROOT/"}" | ||
| fi | ||
| fi | ||
|
|
||
| CTX_PATH="$PROJECT_ROOT/$CONTEXT_FILE" | ||
| mkdir -p "$(dirname "$CTX_PATH")" | ||
|
mnriem marked this conversation as resolved.
|
||
|
|
||
| # Build the managed section | ||
| TMP_SECTION="$(mktemp)" | ||
| trap 'rm -f "$TMP_SECTION"' EXIT | ||
| { | ||
| echo "$MARKER_START" | ||
| echo "For additional context about technologies to be used, project structure," | ||
| echo "shell commands, and other important information, read the current plan" | ||
| if [[ -n "$PLAN_PATH" ]]; then | ||
| echo "at $PLAN_PATH" | ||
| fi | ||
| echo "$MARKER_END" | ||
| } > "$TMP_SECTION" | ||
|
|
||
| "$_python" - "$CTX_PATH" "$MARKER_START" "$MARKER_END" "$TMP_SECTION" <<'PY' | ||
| import sys, os | ||
| ctx_path, start, end, section_path = sys.argv[1:5] | ||
| with open(section_path, "r", encoding="utf-8") as fh: | ||
| section = fh.read().rstrip("\n") + "\n" | ||
|
|
||
| if os.path.exists(ctx_path): | ||
| with open(ctx_path, "r", encoding="utf-8-sig") as fh: | ||
| content = fh.read() | ||
| s = content.find(start) | ||
| e = content.find(end, s if s != -1 else 0) | ||
| if s != -1 and e != -1 and e > s: | ||
| end_of_marker = e + len(end) | ||
| if end_of_marker < len(content) and content[end_of_marker] == "\r": | ||
| end_of_marker += 1 | ||
| if end_of_marker < len(content) and content[end_of_marker] == "\n": | ||
| end_of_marker += 1 | ||
| new_content = content[:s] + section + content[end_of_marker:] | ||
| elif s != -1: | ||
| new_content = content[:s] + section | ||
| elif e != -1: | ||
| end_of_marker = e + len(end) | ||
| if end_of_marker < len(content) and content[end_of_marker] == "\r": | ||
| end_of_marker += 1 | ||
| if end_of_marker < len(content) and content[end_of_marker] == "\n": | ||
| end_of_marker += 1 | ||
| new_content = section + content[end_of_marker:] | ||
| else: | ||
| if content and not content.endswith("\n"): | ||
| content += "\n" | ||
| new_content = (content + "\n" + section) if content else section | ||
| else: | ||
| new_content = section | ||
|
|
||
| new_content = new_content.replace("\r\n", "\n").replace("\r", "\n") | ||
| with open(ctx_path, "wb") as fh: | ||
| fh.write(new_content.encode("utf-8")) | ||
| PY | ||
|
|
||
| echo "agent-context: updated $CONTEXT_FILE" | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.