Context Awareness

Context Awareness Feature

Intent

Provide a stable, verifiable, LLM-readable context layer under docs/context/.

The context-awareness feature standardizes how the project exposes:

• API contracts (OpenAPI)
• Database schema contract (LLM-readable JSON)
• Process contracts (BPMN)
• Environment registry (what exists; policies; no secrets)
• Domain glossary (structured term definitions)
• Architecture principles (cross-cutting constraints and rejected alternatives)

The main outcome is that the LLM can load a small number of canonical entry points and avoid fragile whole-repo discovery.

What gets enabled

When enabled, the feature materializes these paths in the repo root:

• docs/context/** (contracts + registry)
• docs/context/AGENTS.md (LLM routing entrypoint with progressive loading protocol)
• docs/context/knowledge/glossary.json (domain glossary — structured term definitions)
• docs/context/knowledge/glossary.schema.json (glossary JSON Schema for verification)
• docs/context/knowledge/architecture-principles.md (cross-cutting constraints and rejected alternatives)
• config/environments/** (environment config templates; no secrets)

And it assumes these controller scripts exist (they are part of the template SSOT under .ai/):

• node .ai/skills/features/context-awareness/scripts/ctl-context.mjs — context artifacts + registry + environments + glossary
• node .ai/scripts/ctl-project-state.mjs — project state (.ai/project/state.json)
• node .ai/scripts/ctl-openapi-quality.mjs — OpenAPI semantic quality gate
• node .ai/skills/_meta/ctl-skillpacks.mjs — skill pack switching + wrapper sync

Canonical entry points for LLMs

1. docs/context/AGENTS.md (authoritative LLM routing — progressive loading protocol)
2. docs/context/INDEX.md
3. docs/context/registry.json
4. docs/context/api/api-index.json (API overview — read before per-module openapi.yaml)
5. docs/context/knowledge/glossary.json (domain term definitions)
6. docs/context/config/environment-registry.json

If a DB schema exists, the canonical DB contract is:

• docs/context/db/schema.json

That DB contract is produced by the DB SSOT workflow (see ctl-db-ssot, and the database workflow skills).

How to enable

1. Copy templates from:
   • .ai/skills/features/context-awareness/templates/ into the repo root.
2. Initialize:

node .ai/scripts/ctl-project-state.mjs init
node .ai/scripts/ctl-project-state.mjs set context.enabled true
node .ai/scripts/ctl-project-state.mjs set-context-mode contract
node .ai/skills/features/context-awareness/scripts/ctl-context.mjs init
node .ai/skills/features/context-awareness/scripts/ctl-context.mjs touch

Knowledge artifacts

Domain glossary (docs/context/knowledge/glossary.json)

Structured JSON for project-specific term definitions. Manage via CLI:

node .ai/skills/features/context-awareness/scripts/ctl-context.mjs add-term --term "tenant" --definition "An isolated customer organization" --scope global --aliases "organization,org"
node .ai/skills/features/context-awareness/scripts/ctl-context.mjs remove-term --term "tenant"
node .ai/skills/features/context-awareness/scripts/ctl-context.mjs list-terms

Verification: ctl-context verify --strict validates glossary structure when the file exists.

Architecture principles (docs/context/knowledge/architecture-principles.md)

Markdown file for cross-cutting rules and rejected alternatives. Edit directly, then run ctl-context touch.

OpenAPI semantic quality gate

Validates per-module and project-level OpenAPI files for semantic completeness:

node .ai/scripts/ctl-openapi-quality.mjs verify --source modules/<id>/interact/openapi.yaml --strict
node .ai/scripts/ctl-openapi-quality.mjs verify --discover-modules --strict

Checks: required fields (operationId/summary/tags/2xx), unique operationId, security scheme refs, path param declarations, $ref resolution. Optional enhancement: install @apidevtools/swagger-parser for full OpenAPI spec compliance.

Operating rules

Managing project state

Use ctl-project-state to maintain .ai/project/state.json:

node .ai/scripts/ctl-project-state.mjs init
node .ai/scripts/ctl-project-state.mjs set custom.stage <prototype|mvp|production|maintenance|archived>
node .ai/scripts/ctl-project-state.mjs set-context-mode <contract|snapshot>
node .ai/scripts/ctl-project-state.mjs verify

Editing artifacts

After editing any file under docs/context/**:

node .ai/skills/features/context-awareness/scripts/ctl-context.mjs touch

Managing environments

node .ai/skills/features/context-awareness/scripts/ctl-context.mjs list-envs
node .ai/skills/features/context-awareness/scripts/ctl-context.mjs add-env --id qa --description "QA environment"
node .ai/skills/features/context-awareness/scripts/ctl-context.mjs verify-config

Module slice workflow (DB / Env / Observability)

For module-level context slices, follow the standard workflow below:

Step 1 — Ensure repo contracts exist

• DB contract: docs/context/db/schema.json
• Env contract: env/contract.yaml
• Observability contracts: docs/context/observability/*.json

Step 2 — Declare module boundaries in MANIFEST.yaml

# modules/<module_id>/MANIFEST.yaml
db:
  owns:
    - table: users
  uses:
    - table: orders

env:
  owns:
    - SERVICE_API_KEY
  requires:
    - LOG_LEVEL

observability:
  metrics:
    owns:
      - http_requests_total
    uses:
      - auth_login_total
  logs:
    owns:
      - billing_account_id
    requires:
      - trace_id

Step 3 — Validate and sync slices

# DB slices
node .ai/scripts/modules/ctl-db-ssot-module.mjs verify --strict
node .ai/scripts/modules/ctl-db-ssot-module.mjs conflicts
node .ai/scripts/modules/ctl-db-ssot-module.mjs sync-slices --module-id <module_id>

# Env slices
node .ai/scripts/modules/ctl-env-contract-module.mjs verify --strict
node .ai/scripts/modules/ctl-env-contract-module.mjs conflicts
node .ai/scripts/modules/ctl-env-contract-module.mjs sync-slices --module-id <module_id>

# Observability slices
node .ai/scripts/modules/ctl-obs-module.mjs verify --strict
node .ai/scripts/modules/ctl-obs-module.mjs conflicts
node .ai/scripts/modules/ctl-obs-module.mjs sync-slices --module-id <module_id>

Step 4 — Rebuild aggregated context

node .ai/skills/features/context-awareness/scripts/ctl-context.mjs build
node .ai/skills/features/context-awareness/scripts/ctl-context.mjs verify --strict

Related skills

• manage-db-module-slices
• manage-env-module-slices
• manage-observability-module-slices

Verification

node .ai/skills/features/context-awareness/scripts/ctl-context.mjs verify --strict
node .ai/scripts/ctl-project-state.mjs verify

References

• reference/feature-overview.md
• reference/feature-mechanism.md
• reference/operating-guide.md
• reference/project-state-guide.md

Boundaries

• Do NOT store credentials or secrets in docs/context/ or config/.
• Do NOT hand-edit generated context artifacts without re-running ctl-context touch.
• Use DB SSOT workflows to update docs/context/db/schema.json.

Converted and distributed by TomeVault — claim your Tome and manage your conversions.