Skip to content

Functional Requirements

Document ID: PRD-004
File Path: docs/01-product/functional-requirements.md
Version: 1.0.0
Status: Draft
Owner: Product Team
Last Updated: 2026-06-27

1. Purpose

This document enumerates the functional requirements (FRs) for the Wovyr AI Platform — what the system must do. FRs are derived from the PRD and user stories, and each points to the spec that realizes it.

2. Conventions

FR-<area>-<n>  ·  Priority: MUST | SHOULD | MAY  ·  Spec: <link>

3. Agents

ID	Requirement	Pri	Spec
FR-AGT-1	Define agents declaratively (model, instructions, tools, memory, policies)	MUST	agent-definition
FR-AGT-2	Execute an agent against a goal/input	MUST	agent-runtime-protocol
FR-AGT-3	Stream run progress (planner, tools, model, memory)	MUST	Agents API §6
FR-AGT-4	Maintain multi-turn sessions	SHOULD	Agents API §7
FR-AGT-5	Version and publish agents	MUST	Agents API §8

4. Workflows

ID	Requirement	Pri	Spec
FR-WF-1	Author workflows in a DSL (YAML/JSON/visual/SDK)	MUST	workflow-dsl
FR-WF-2	Execute durably with checkpoint/resume	MUST	checkpointing
FR-WF-3	Support human-approval tasks	MUST	Workflows API §8
FR-WF-4	Support retries and compensation (saga)	MUST	retry / compensation
FR-WF-5	Branching, parallelism, loops, sub-workflows	MUST	workflow-dsl
FR-WF-6	Event/timer-driven execution	SHOULD	Workflows API §7

5. Memory

ID	Requirement	Pri	Spec
FR-MEM-1	Store/version/retrieve memory records	MUST	memory-api
FR-MEM-2	Hybrid (vector+keyword+graph) retrieval with ranking	MUST	retrieval / ranking
FR-MEM-3	Scope and access-control memory per tenant/project	MUST	memory scopes
FR-MEM-4	Compress retrieved context to a token budget	SHOULD	compression

6. LLM Gateway

ID	Requirement	Pri	Spec
FR-LLM-1	Provider-neutral inference (chat/embeddings/etc.)	MUST	provider-api
FR-LLM-2	Routing, failover, resilience	MUST	routing / resilience
FR-LLM-3	Token accounting, budgets, cost events	MUST	token-management
FR-LLM-4	Response caching	SHOULD	caching

7. Tools

ID	Requirement	Pri	Spec
FR-TOOL-1	Execute tools in isolated sandboxes with limits	MUST	tool-runtime
FR-TOOL-2	Discover/register/version tools	MUST	tool-framework
FR-TOOL-3	Enforce per-tool permissions and egress control	MUST	security-isolation
FR-TOOL-4	Provide a built-in tool catalog (fs/shell/http/git/db/…)	SHOULD	tool catalog

8. Plugins

ID	Requirement	Pri	Spec
FR-PLG-1	Author/package/sign plugins	MUST	plugin-api / distribution
FR-PLG-2	Install/version/upgrade plugins at runtime	MUST	versioning
FR-PLG-3	Declare and grant least-privilege permissions	MUST	permissions
FR-PLG-4	Marketplace discovery + governance	SHOULD	marketplace

9. API, Security & Tenancy

ID	Requirement	Pri	Spec
FR-API-1	REST + gRPC management API (`/v1`)	MUST	API overview
FR-SEC-1	AuthN (OAuth2/JWT/API key/mTLS)	MUST	authentication
FR-SEC-2	AuthZ via RBAC + ABAC, fail-closed	MUST	authorization
FR-SEC-3	Encryption in transit & at rest; secret vault	MUST	encryption / secrets
FR-SEC-4	Tamper-evident audit of sensitive actions	MUST	audit
FR-ADM-1	Manage orgs/projects/users/quotas	MUST	projects / users

10. Dashboard, CLI & Observability

ID	Requirement	Pri	Spec
FR-UI-1	Web dashboard for build/operate/monitor	MUST	dashboard
FR-DX-1	CLI with API parity + local mode	MUST	CLI
FR-DX-2	Rust SDK + scaffolding	SHOULD	build-system §6
FR-OBS-1	Logs, metrics, traces, dashboards, alerts	MUST	observability

11. Traceability

Each FR links to user stories and is validated by acceptance criteria and tests, per PRD §23.

01-product/prd.md · 01-product/non-functional-requirements.md

13. Revision History

Version	Date	Description
1.0.0	2026-06-27	Initial Functional Requirements