canned-prompts/SCOPE.md
tegwick dc615ef530 Register with Custodian State Hub and seed format open-questions workplan
Register canned-prompts under agents / practice (topic
c1d199b6-55ee-4db6-b49e-257a9f0f15ac, workplan prefix CANP-WP) via
`statehub register`, then replace the generated placeholders with
repo-specific facts.

- SCOPE.md: real boundaries drawn from INTENT.md's deliberate boundary,
  current state (spec v0.1 + reference CLI, 3/3 tests pass, example
  round-trips), and the developer workflow.
- AGENTS.md: drop the unresolved {CREDENTIAL_ROUTING} template token left
  by the generator.
- CANP-WP-0001: bootstrap tasks closed.
- CANP-WP-0002: new workplan carrying the five § 23 open questions promoted
  from "experience will decide" to "decide for v0.2" — optional-input
  defaults (static or derived), registry namespaces/ownership, prompt
  composition, canonical eval schemas, typed context/dependency contracts —
  plus two reference-implementation conformance defects found in review
  (prerelease versions sort as newest; copy_immutable packages the whole
  source directory).

Also lands the previously untracked seed: INTENT.md, the CPF v0.1 spec,
the reference CLI, and examples/pqrst-estimate.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Bjefh8NUiEiahN4JLwoSKM

Assistant: claude-code
Assistant-Model: opus
Assistant-Process: 388925@bnt-lap001
Assistant-Session: 3507023f-e0fd-4a1e-9d90-a0d4217d1502
2026-09-06 00:45:28 +02:00

2.4 KiB

SCOPE

One-liner

Portable package format, spec and reference CLI for reusable prompt artifacts (Canned Prompt Format v0.1).

Core Idea

The valuable unit is not prompt text but a reusable prompt contract: a filesystem-portable, provider-neutral package (prompt.yaml + prompt.md) that declares its purpose, inputs, parameters, output, compatibility, provenance and evidence, and is inspectable before use. See INTENT.md.

In Scope

  • CannedPromptFormat-v0.1.md — the package-format specification.
  • reference/ — a deliberately small Python CLI (add, search, show, render, install, publish) over a filesystem catalog and registry.
  • examples/ — real packages that exercise the format and the implementation.
  • Format evolution: manifest surface, rendering rules, validation rules, registry semantics, provenance and eval hooks.

Out of Scope

Per INTENT.md § Deliberate boundary — canned-prompts standardizes reusable prompt artifacts, not agent execution:

  • model execution, routing, billing, or authentication;
  • agent runtimes, workflow/orchestration engines, memory systems;
  • hosted or federated registries and network transport (v0.1 is filesystem-only);
  • dependency resolution, semver range resolution, package signing;
  • trust/reputation scoring and social features.

Thin execution adapters are permitted; a general runtime is not.

Current State

  • Seed / experimental. Spec v0.1 is written; the reference CLI implements the full local lifecycle and its 3 tests pass. One example package (examples/pqrst-estimate) round-trips add → search → show → render → publish → install.
  • The reference implementation is spec-conformant on the points it covers; the known open design questions are tracked in workplans/CANP-WP-0002-*.md.

Developer Workflow

cd reference
python3 -m venv .venv && . .venv/bin/activate
pip install -r requirements-dev.txt

python3 -m pytest -q                        # tests
CANNED_PROMPTS_HOME=/tmp/cp \
  python3 canned_prompts.py add ../examples/pqrst-estimate   # smoke

There is no lint or build step yet; pyproject.toml declares the canned-prompts console script but the module is normally run directly.

Getting Oriented

  • Intent and principles: INTENT.md
  • Format specification: CannedPromptFormat-v0.1.md
  • Agent instructions: AGENTS.md
  • Workplans: workplans/