Skip to main content

Feature request and implementation specification management tool

Project description

nspec

PyPI version Python 3.11+ License: MIT Docs

Specification-driven project management for AI-native development

nspec turns your backlog into structured markdown specs that AI coding assistants can read, execute, and update. It pairs every feature request (FR) with an implementation spec (IMPL), validates the entire graph, and exposes an MCP server so Claude Code (or any MCP-compatible agent) can autonomously pick up work, track tasks, run reviews, and advance specs through their lifecycle.

Install

pip install nspec

Also available via pipx, uv, and poetry. See the Getting Started guide.

Quick Start

nspec init              # Scaffold project (auto-detects your stack)
nspec mcp-config        # Generate MCP server config
nspec spec create --title "My feature" --priority P1
nspec validate          # Run 6-layer validation
nspec tui               # Interactive terminal UI

With the MCP server configured, Claude Code can autonomously work your backlog:

/ngo S001       — Start a work session on a spec
/nbacklog       — View the prioritized backlog
/nloop          — Autonomous mode: pick, execute, review, complete, repeat

At loop entry, /nloop seeds itself once with epic-wide FR intent via a loop-entry seed_context step (the epic_fr_context tool): it reads every member spec's Goal/Scope/Acceptance Criteria — regardless of state, so even un-started specs contribute — and grounds the whole run in what the epic intends, the FR-side complement to epic_context's per-spec delivered outcomes.

Features

  • FR/IMPL Pairing — Every feature request gets a matching implementation spec with hierarchical tasks and acceptance criteria
  • 6-Layer Validation — Format, pairing, dependencies, business logic, and ordering checks
  • MCP Server — 89 tools over stdio, SSE, and HTTP transports for AI assistant integration
  • Interactive TUI — Sortable table, detail panel, vim keybindings, search, follow mode, live reload, and in-terminal dependency-graph visualization (expand upstream/downstream, jump between linked specs)
  • Dependency Graph — Circular reference detection, cross-epic ordering, priority inheritance
  • Skills System — 29 slash commands for Claude Code (spec creation, review, triage, autonomous loops) plus Codex prompt templates
  • Multi-Agent Queue — Parallel spec execution with git-worktree isolation, atomic claim/release, and lease-based recovery
  • Checkout & Reservation — TTL-based spec leases prevent double-assignment across agents
  • GitHub Issue Integration — Import issues as specs and sync status back to GitHub on completion
  • Code Review — Automated review against spec criteria via configurable external agents (Codex, Gemini)
  • Engineering Metrics — Velocity, quality, DORA metrics, and activity heatmap

Priority Model

  • Epic priorities are global and unique. Epics rank against each other in one contiguous order (P1, P2, P3, …). Changing an epic's priority cascade-inserts it — the others shift up or down to keep every slot unique.
  • Spec priorities (P0–P3) are scoped to their epic. A spec's priority only orders it against its siblings within the same epic — it is contained there and has no meaning across epics. Two specs may share a priority; ties break deterministically by spec ID. IDs are S/E + a zero-padded number (S001); the 3-digit space is a floor, not a cap — once it fills, IDs widen to four digits (S1000S9999) automatically, and the allocator fails loud rather than ever reusing an ID. Changing a spec's priority bumps its epic siblings to make room (best-effort: because the P0–P3 range is smaller than the number of specs an epic can hold, siblings pile up at the floor priority once the range is exhausted rather than overflowing past it).
  • Dependency order is the default sort, and it ignores P-numbers. The TUI's default sort:dependency orders specs by a topological sort of their deps, not by priority. A spec with no dependency edges to its siblings is an orphan and falls to the end of its epic, ordered only by its (often default) priority. To make the dependency graph authoritative, enable the optional gate [validation] enforce_epic_dependency_chain = true: validation then fails unless every epic's active specs form one connected dependency chain (branches are fine; disconnected islands and orphans are not). Wire specs together with add_dep to satisfy it.

Epic FR contract

Every epic carries a PRD-style contract so a reader can tell what it is for and when it is done without reverse-engineering it from child specs. create_spec(is_epic=True) scaffolds the FR from a dedicated epic template (src/nspec/resources/templates/epic/fr.md) with these sections: Goal, Why It Matters, Scope (In / Out), Definition of Complete, Child Specs, and Acceptance Criteria. Definition-of-Complete items are plain bullets describing the epic's end-state; only Acceptance Criteria are tracked checkboxes, so per-epic progress accounting is unchanged. A project can override the template by dropping its own copy at .novabuilt.dev/nspec/templates/epic/fr.md, which wins over the builtin.

Epic-level review

/nreview-epic <epic> batch-reviews every child spec of an epic. It reuses the single-spec review machinery rather than re-implementing it: for each child it runs the same chain /ngo and /nreview use — review_spec (mints the review prompt file) → execute_agent (dispatches to the external review agent, Codex/Gemini) → write_review_verdict (persists the verdict + a Review History row into the child's IMPL). So an epic review leaves the same durable per-spec audit trail a single-spec review does — not an ephemeral console table. It does not advance any spec's lifecycle status (it records verdicts only) and has no self-review path — the external agent always reviews, never the implementing agent. --converge wraps the per-spec chain in an iteration loop that surfaces cross-cutting themes (issues spanning 2+ specs) and drives atomic multi-file fixes until the epic's specs stop churning.

Documentation

Full documentation: novabuilt.dev/nspec

Development

poetry install
make test-quick    # Fast tests, fail-fast
make check         # Format + lint + typecheck

Type-aware verify: /ngo's verify step runs the command appropriate to what a spec changes — make test-quick for code, mkdocs build --strict for docs — instead of always running the full test suite. A spec selects its profile with a verify_profile: docs annotation in its FR (unannotated specs are code); projects add or override profiles under [verify.profiles] in config.toml, or per-run via an NSPEC_VERIFY_<PROFILE> env var (env > config > built-in default). Resolution fails closed: an unknown profile falls back to the code command, so verification is never silently skipped.

License

MIT License - see LICENSE for details.

Credits

Built with Poetry, Textual, Rich, and MCP.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nspec-3.18.0.tar.gz (735.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nspec-3.18.0-py3-none-any.whl (866.7 kB view details)

Uploaded Python 3

File details

Details for the file nspec-3.18.0.tar.gz.

File metadata

  • Download URL: nspec-3.18.0.tar.gz
  • Upload date:
  • Size: 735.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.14.6 Linux/6.1.0-44-amd64

File hashes

Hashes for nspec-3.18.0.tar.gz
Algorithm Hash digest
SHA256 617eb17c18b279d81484648e6ae31b5150b98e1bd205b3fee67f35bc4ce889ef
MD5 549363b7a754ec828fa6a4486d059b77
BLAKE2b-256 2e4d6d673f3c840d85dc4551f021c0764d291e00a9bf2209e72781e9441ab902

See more details on using hashes here.

File details

Details for the file nspec-3.18.0-py3-none-any.whl.

File metadata

  • Download URL: nspec-3.18.0-py3-none-any.whl
  • Upload date:
  • Size: 866.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.14.6 Linux/6.1.0-44-amd64

File hashes

Hashes for nspec-3.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 861eeaa5f3bb5bca4098b492c8c31dafd74be2e0d7b0244b2f5740e9d1070c25
MD5 501a3426c32fba26a39f06dd94801e6c
BLAKE2b-256 dbcd55af508dbd110f723614586622dd2f5110dbd3913d8001e93f3483654912

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page