archflow-contract

Creates and maintains API contract architecture and per-story endpoint specifications.

28|4|Updated Mar 12, 2026
One-click install
npx skills add https://github.com/AZidan/archflow --skill archflow-contract-azidan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: archflow-contract
Source: https://github.com/AZidan/archflow/tree/main/adapters/copilot/.github/skills/archflow-contract
Command: npx skills add https://github.com/AZidan/archflow --skill archflow-contract-azidan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Frontend and backend engineers drift apart when API conventions are not locked down, and stories get built against inconsistent or missing endpoint specs. This Skill establishes a single API contract document with shared architecture rules and specifies each story's endpoints one step ahead of its build, clearing the story's contract gate. ## Core Features & Use Cases - Contract Architecture Foundation: Creates the release-level contract defining auth pattern, URL and JSON conventions, error envelope, pagination, and versioning that every endpoint must obey. - Per-Story Endpoint Specification: Appends one story's endpoints under its own heading, validates gate state, and advances the story to contract_ready only after human acceptance. - Contract Path Management: Relocates the contract file or repoints the api_contract_path setting, with confirmation prompts and a scan for stale references. - Use Case: Before building story S7-20, run the contract command with that story id to have the api-contract-architect agent append its endpoints to the shared contract, review them, and clear the story's needs_contract gate. ## Quick Start Ask the agent to run /archflow-contract S7-20 to specify that story's endpoints against the existing contract architecture and clear its contract gate.

Frequently Asked Questions about archflow-contract

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I specify API endpoints for a story before building it?

Run /archflow-contract with the story id, such as /archflow-contract S7-20. The skill checks the story's gate state, dispatches the api-contract-architect agent to append endpoints to the contract, and advances the story to contract_ready after you accept.

How do I create an API contract architecture for a release?

Run /archflow-contract with no arguments. If no contract exists at the configured path, it confirms creation and dispatches the api-contract-architect in foundation mode to write the auth pattern, URL and JSON conventions, error envelope, pagination, and versioning.

Can I specify endpoints for a story still in the backlog?

No. Endpoints are specified one step ahead of a story's build, not ahead of scheduling. The skill stops and directs you to pull the story into the active release first with /archflow-feature.

Does the contract gate apply in quick mode?

In quick mode the contract gate auto-satisfies, so the skill reports that the step is unnecessary and offers an explicit override to specify endpoints anyway. In full mode it proceeds without asking.

How do I move the API contract to a different file path?

Run /archflow-contract path <new-path>. If a contract file already exists there it updates the api_contract_path setting; otherwise it asks whether to move the file with git mv or only update the pointer, then reports stale references to the old path.