Skip to content

docs: AGENTS.example.md names the surfaces that load from ~/.openmax/ - #224

Merged
Max17190 merged 1 commit into
mainfrom
docs/agents-example-names-the-global-surfaces
Aug 18, 2026
Merged

docs: AGENTS.example.md names the surfaces that load from ~/.openmax/#224
Max17190 merged 1 commit into
mainfrom
docs/agents-example-names-the-global-surfaces

Conversation

@Max17190

@Max17190 Max17190 commented Aug 18, 2026

Copy link
Copy Markdown
Owner

Why

Follow-up to #223. The trimmed AGENTS.example.md said the file surfaces the system prompt names "each also load from ~/.openmax/". Two of them do not: memory is project-only (.openmax/memory/, memory.rs), and providers is global-only (~/.openmax/providers.json). The file's own Development rule is "never invent paths or claim missing features", so the sentence has to be exact.

Summary

  • Name the five surfaces that do have a ~/.openmax/ mirror: tools, skills, prompt templates, hooks, permissions (registry::external_tool_dirs, skills::skill_dirs, templates::template_dirs, hooks::hook_dirs, permissions::permission_files), project winning on a name collision as README and docs/extending.md state.
  • Drop "(run it after writing one)": the frozen prompt already says "Verify what you wrote with bash: openmax --check" on every request, so the template was paying for it twice.
  • 1,953 bytes; agents_example_fits_the_injection_cap stays green.

Test Plan

  • cargo test -p open-max-core --lib agents_example_fits_the_injection_cap: passes at 1,953 bytes.
  • The five global directories named are the ones each loader reads (file:line above); memory and providers are the two the sentence no longer claims.

Greptile Summary

This update makes the example project instructions accurately name the five extension surfaces that can load from ~/.openmax/: tools, skills, prompt templates, hooks, and permissions. The project-first precedence guidance remains intact. Focused checks confirmed those loading and precedence behaviors, and the revised example remains within the instruction-injection limit.

Confidence Score: 5/5

Safe to merge: the updated documentation matches the implemented extension-loading behavior.

Focused Rust tests passed for the instruction-size guard and project-over-global precedence across tools, skills, prompt templates, hooks, and permissions. The revised example measured 1,954 bytes, below the 2,000-byte limit.

Files Needing Attention: No files need further attention.

T-Rex T-Rex Logs

What T-Rex did

  • The AGENTS.example.md documentation file was measured before and after the update, and the revised size is 1,954 bytes, staying under the 2,000-byte injection limit.
  • Six focused Rust tests covering the injection cap and global precedence for tools, skills, prompt templates, hooks, and permissions were run, and all passed.
  • The checks confirm that the documentation describes the implemented global-loading surfaces and precedence behavior.

View all artifacts

T-Rex Ran code and verified through T-Rex

Reviews (1): Last reviewed commit: "docs: AGENTS.example.md names the surfac..." | Re-trigger Greptile

The trimmed template said every surface the system prompt names also loads
from ~/.openmax/. Memory is project-only (.openmax/memory) and providers.json
is global-only, so name the five that do: tools, skills, prompt templates,
hooks, permissions. Drops the parenthetical the frozen prompt already carries
(run --check after writing) so the file keeps its headroom under the cap:
1,953 bytes, guard green.
@Max17190
Max17190 merged commit d98ed6e into main Aug 18, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant