title	Specorator repository overview
doc_type	home
status	draft
owner	product
last_updated	2026-05-01
references	docs/product-vision.md docs/prd.md docs/roadmap-v1.md

Specorator

luis85.github.io/specorator · Try it live in your browser →

Specorator is an Obsidian plugin and companion app for spec-driven, agentic software development. It guides users through a structured workflow — from idea to release — keeping all artifacts as editable Markdown inside the vault.

Current status: Plugin shell complete. v1 alpha feature delivery in progress.

What it does

v1 alpha establishes the plugin foundation:

• Installs and manages the agentic-workflow template inside an Obsidian vault.
• Provides a workflow cockpit: active stage, required artifacts, next actions, and quality checks.
• Keeps all generated content as plain Markdown — readable and usable without the plugin.

v2.0 adds a companion-app experience:

• Integrates agentonomous to provide a team of agentic coworkers that assist with drafting, review, and workflow progression.
• Users stay focused on their vault; they decide what context agents can see, what they propose, and what becomes a durable artifact.

Documentation

Document	Purpose
docs/product-vision.md	Product north star, principles, and v1/v2.0 direction
docs/prd.md	v1 and v2.0 product requirements documents
docs/roadmap-v1.md	Phased delivery plan for v1 alpha
docs/pre-feature-architecture-readiness.md	Architecture and infrastructure readiness review before feature delivery
docs/process/requirements-intake.md	Intake-first requirements and design workflow
docs/contributing.md	Labels, milestones, branch naming, and merge policy
docs/traceability.md	Requirements traceability index and ID conventions
docs/glossary.md	Product terminology baseline
docs/github-workspace.md	GitHub Project board, views, fields, and admin setup
docs/initiation.md	P3.express initiation package and go/no-go decision

Project tracking

Issue	Purpose
#47 — Roadmap progress tracker	Phase-by-phase checklist
#1 — v1 alpha planning	v1 feature scope and acceptance criteria
#23 — v2.0 planning	Companion-app and agentonomous direction
#2 — Repo setup objective	Repository and GitHub foundation work
#11 — Plugin shell objective	Plugin architecture and toolchain
#24 — Product setup objective	PRDs, use cases, and product artifacts

Install (BRAT — beta)

Specorator is not yet on the Obsidian community marketplace. While in v1 alpha you can install it via BRAT to receive automatic updates from this repository.

1. Install BRAT from the Obsidian community plugins.
2. Open BRAT settings → Add Beta plugin.
3. Paste the repository URL: https://github.com/Luis85/specorator.
4. Click Add Plugin. BRAT installs the latest tagged release and will auto-update on each new release.

Marketplace submission will follow once BRAT distribution has validated stability. Until then, BRAT is the only supported install path.

Getting started

After installing via BRAT and enabling the plugin:

1. A Specorator icon appears in the Obsidian ribbon. Click it to open the workflow cockpit, or run Open Specorator from the command palette.
2. The cockpit lists your active features. Each feature tracks its current workflow stage — from idea through to retrospective — and surfaces the next required artifact.
3. All generated content is plain Markdown inside your vault. You can read and edit artifacts directly whether or not the plugin is loaded.
4. The browser demo previews the full workflow UI without installing anything.

v1 alpha: The plugin shell is installed and loads. Full workflow cockpit features are in active development. Functionality may be limited until v1 is complete.

MCP server (advanced, opt-in)

Specorator can expose a local Model Context Protocol (MCP) endpoint so AI clients on the same machine can read and propose changes against your vault.

• Off by default. No server is started on a fresh install. Existing installs upgrading to this version retain mcpServerEnabled = false unless they had previously enabled it.
• Loopback only. The server binds to 127.0.0.1 on a randomly assigned port and rejects requests with a non-loopback Host header. There is no authentication — trust is derived from your local machine.
• How to enable. Open Settings → Specorator and toggle Enable MCP server (advanced), or run the command Start MCP server from the command palette.
• How to disable. Toggle the setting off, run the command Stop MCP server, or set "mcpServerEnabled": false in the plugin's data.json under the specorator key.
• Status. The settings tab shows whether the server is currently Running or Stopped (re-open the tab to refresh).

If you don't use MCP clients, leave this off — Specorator's vault-side functionality works without it.

Development

See docs/local-development.md for the full setup guide: prerequisites, commands, sideloading into an Obsidian test vault, and pre-PR verification steps.

Stack: Obsidian community plugin · Vue 3 · Vue Router · Pinia 2 · TypeScript 5.8 · Vite · Vitest · ESLint · TypeDoc

Contributing

Issues and pull requests are welcome. See the roadmap for current priorities.

Intake-first workflow: new requirements and design decisions go through a structured intake process before implementation begins.

• Open a Requirement intake or Design intake issue using the provided templates.
• Add a requirement draft under requirements/intake/ using REQ-0000-template.md.
• Follow docs/process/requirements-intake.md for triage and promotion steps.

Related repositories

• agentic-workflow — workflow methodology, templates, and quality gates. Upstream planning issue.
• agentonomous — agent orchestration engine used in v2.0.