ai-dev-requirements 0.1.2 → 0.1.3

package/README.md

@@ -1,227 +1,227 @@
-# AI Development Workflow
-
-[中文](./README.zh-CN.md)
-
-A parallel-task development framework for AI coding tools, enabling end-to-end development workflow automation.
-
----
-
-## What's Included
-
-| Deliverable | Description |
-|-------------|-------------|
-| **Requirements MCP Server** (`src/`) | MCP server for fetching requirements, with built-in ONES adapter. Installable via npm. |
-| **Dev Workflow Skill** (`skills/dev-workflow/`) | Self-contained development workflow skill. Install it and run the full process. |
-
----
-
-## Quick Start
-
-### 1. Install Dev Workflow Skill
-
-```bash
-npx skills add daguanren21/ai-dev-workflow
-```
-
-Install to a specific agent with `-a`:
-
-```bash
-npx skills add daguanren21/ai-dev-workflow -a claude-code
-```
-
-Once installed, AI coding tools will automatically use the dev-workflow skill to drive the full development process.
-
-### 2. Install MCP Server (Optional)
-
-If you use ONES for requirement management:
-
-```bash
-npm install -g ai-dev-requirements
-```
-
-Create `.requirements-mcp.json` in your project root:
-
-```json
-{
-  "sources": {
-    "ones": {
-      "enabled": true,
-      "apiBase": "https://your-org.ones.com",
-      "auth": {
-        "type": "ones-pkce",
-        "emailEnv": "ONES_ACCOUNT",
-        "passwordEnv": "ONES_PASSWORD"
-      }
-    }
-  },
-  "defaultSource": "ones"
-}
-```
-
-Add to your `.mcp.json`:
-
-```json
-{
-  "mcpServers": {
-    "requirements": {
-      "command": "npx",
-      "args": ["ai-dev-requirements"],
-      "env": {
-        "ONES_ACCOUNT": "${ONES_ACCOUNT}",
-        "ONES_PASSWORD": "${ONES_PASSWORD}"
-      }
-    }
-  }
-}
-```
-
-### 3. Add Companion MCP Servers (Optional)
-
-Requirements are not limited to ONES. Pair with official MCP servers for GitHub / Jira / Figma:
-
-```json
-{
-  "mcpServers": {
-    "github": {
-      "command": "docker",
-      "args": ["run", "-i", "--rm", "-e", "GITHUB_PERSONAL_ACCESS_TOKEN", "ghcr.io/github/github-mcp-server"],
-      "env": { "GITHUB_PERSONAL_ACCESS_TOKEN": "${GITHUB_TOKEN}" }
-    },
-    "figma": {
-      "url": "https://mcp.figma.com/mcp"
-    }
-  }
-}
-```
-
----
-
-## Supported Requirement Platforms
-
-| Platform | Integration | Description |
-|----------|-------------|-------------|
-| ONES | Built-in adapter | Directly supported by this MCP server, OAuth2 PKCE auth |
-| GitHub Issues | External MCP | Use [github/github-mcp-server](https://github.com/github/github-mcp-server) |
-| Jira | External MCP | Use [Atlassian Rovo MCP Server](https://www.atlassian.com/blog/announcements/remote-mcp-server) |
-
-> This project uses an adapter architecture (`BaseAdapter`). To add a new platform as a built-in adapter, extend `SourceType` and implement `BaseAdapter`.
-
----
-
-## Dev Workflow Skill
-
-A self-contained AI-assisted development workflow skill that drives 7 phases:
-
-```
-Requirements → User Stories → UI Resources → Skill Matching → Implementation Plan → Code → Verification
-```
-
-Skill directory structure:
-
-```
-skills/dev-workflow/
-├── SKILL.md                         # Skill entry (YAML frontmatter + workflow definition)
-└── references/
-    ├── workflow.md                  # 10-step end-to-end workflow
-    ├── task-types.md                # Task types, scheduling strategies, declaration syntax
-    ├── service-transform.md         # Service-layer transform pattern for Mock/API adaptation
-    └── templates/                   # Task declaration templates
-        ├── code-dev-task.md
-        ├── code-fix-task.md
-        ├── code-refactor-task.md
-        ├── doc-write-task.md
-        ├── research-task.md
-        └── test-task.md
-```
-
----
-
-## Project Structure
-
-```
-ai-dev-workflow/
-├── skills/dev-workflow/             # Dev Workflow Skill (self-contained)
-│   ├── SKILL.md
-│   └── references/
-│       ├── workflow.md
-│       ├── task-types.md
-│       ├── service-transform.md
-│       └── templates/
-│
-├── src/                             # Requirements MCP Server source
-│   ├── index.ts                     # Entry & MCP Server definition
-│   ├── adapters/
-│   │   ├── base.ts                  # BaseAdapter abstract class
-│   │   ├── ones.ts                  # ONES adapter
-│   │   └── index.ts                 # Factory function createAdapter()
-│   ├── config/
-│   │   └── loader.ts                # Config loading & env resolution
-│   ├── tools/
-│   │   ├── get-requirement.ts       # get_requirement tool
-│   │   ├── search-requirements.ts   # search_requirements tool
-│   │   └── list-sources.ts          # list_sources tool
-│   ├── types/
-│   │   ├── auth.ts
-│   │   ├── config.ts
-│   │   └── requirement.ts
-│   └── utils/
-│       ├── http.ts
-│       └── map-status.ts
-│
-├── tests/                           # Tests
-├── .requirements-mcp.json.example   # MCP Server config template
-├── package.json
-├── tsconfig.json
-├── tsdown.config.ts
-└── vitest.config.ts
-```
-
----
-
-## Tech Stack
-
-| Technology | Purpose |
-|------------|---------|
-| TypeScript | MCP Server language |
-| [@modelcontextprotocol/sdk](https://github.com/modelcontextprotocol/typescript-sdk) | MCP protocol SDK |
-| [Zod](https://zod.dev/) | Schema validation & type inference |
-| [tsdown](https://github.com/nicepkg/tsdown) | Build tool (ESM + CJS + dts) |
-| [Vitest](https://vitest.dev/) | Test framework |
-| [bumpp](https://github.com/antfu/bumpp) | Version management & publishing |
-| Node.js >= 20 | Runtime |
-
----
-
-## Development
-
-```bash
-# Install dependencies
-pnpm install
-
-# Dev mode
-pnpm dev
-
-# Build
-pnpm build
-
-# Run tests
-pnpm test
-
-# Type check
-pnpm lint
-```
-
-### Publishing
-
-This project uses [bumpp](https://github.com/antfu/bumpp) for version management:
-
-```bash
-# Interactive version bump, auto commit + tag + push
-pnpm release
-```
-
----
-
-## License
-
-[MIT](LICENSE)
+# AI Development Workflow
+
+[中文](./README.zh-CN.md)
+
+A parallel-task development framework for AI coding tools, enabling end-to-end development workflow automation.
+
+---
+
+## What's Included
+
+| Deliverable | Description |
+|-------------|-------------|
+| **Requirements MCP Server** (`src/`) | MCP server for fetching requirements, with built-in ONES adapter. Installable via npm. |
+| **Dev Workflow Skill** (`skills/dev-workflow/`) | Self-contained development workflow skill. Install it and run the full process. |
+
+---
+
+## Quick Start
+
+### 1. Install Dev Workflow Skill
+
+```bash
+npx skills add daguanren21/ai-dev-workflow
+```
+
+Install to a specific agent with `-a`:
+
+```bash
+npx skills add daguanren21/ai-dev-workflow -a claude-code
+```
+
+Once installed, AI coding tools will automatically use the dev-workflow skill to drive the full development process.
+
+### 2. Install MCP Server (Optional)
+
+If you use ONES for requirement management:
+
+```bash
+npm install -g ai-dev-requirements
+```
+
+Create `.requirements-mcp.json` in your project root:
+
+```json
+{
+  "sources": {
+    "ones": {
+      "enabled": true,
+      "apiBase": "https://your-org.ones.com",
+      "auth": {
+        "type": "ones-pkce",
+        "emailEnv": "ONES_ACCOUNT",
+        "passwordEnv": "ONES_PASSWORD"
+      }
+    }
+  },
+  "defaultSource": "ones"
+}
+```
+
+Add to your `.mcp.json`:
+
+```json
+{
+  "mcpServers": {
+    "requirements": {
+      "command": "npx",
+      "args": ["ai-dev-requirements"],
+      "env": {
+        "ONES_ACCOUNT": "${ONES_ACCOUNT}",
+        "ONES_PASSWORD": "${ONES_PASSWORD}"
+      }
+    }
+  }
+}
+```
+
+### 3. Add Companion MCP Servers (Optional)
+
+Requirements are not limited to ONES. Pair with official MCP servers for GitHub / Jira / Figma:
+
+```json
+{
+  "mcpServers": {
+    "github": {
+      "command": "docker",
+      "args": ["run", "-i", "--rm", "-e", "GITHUB_PERSONAL_ACCESS_TOKEN", "ghcr.io/github/github-mcp-server"],
+      "env": { "GITHUB_PERSONAL_ACCESS_TOKEN": "${GITHUB_TOKEN}" }
+    },
+    "figma": {
+      "url": "https://mcp.figma.com/mcp"
+    }
+  }
+}
+```
+
+---
+
+## Supported Requirement Platforms
+
+| Platform | Integration | Description |
+|----------|-------------|-------------|
+| ONES | Built-in adapter | Directly supported by this MCP server, OAuth2 PKCE auth |
+| GitHub Issues | External MCP | Use [github/github-mcp-server](https://github.com/github/github-mcp-server) |
+| Jira | External MCP | Use [Atlassian Rovo MCP Server](https://www.atlassian.com/blog/announcements/remote-mcp-server) |
+
+> This project uses an adapter architecture (`BaseAdapter`). To add a new platform as a built-in adapter, extend `SourceType` and implement `BaseAdapter`.
+
+---
+
+## Dev Workflow Skill
+
+A self-contained AI-assisted development workflow skill that drives 7 phases:
+
+```
+Requirements → User Stories → UI Resources → Skill Matching → Implementation Plan → Code → Verification
+```
+
+Skill directory structure:
+
+```
+skills/dev-workflow/
+├── SKILL.md                         # Skill entry (YAML frontmatter + workflow definition)
+└── references/
+    ├── workflow.md                  # 10-step end-to-end workflow
+    ├── task-types.md                # Task types, scheduling strategies, declaration syntax
+    ├── service-transform.md         # Service-layer transform pattern for Mock/API adaptation
+    └── templates/                   # Task declaration templates
+        ├── code-dev-task.md
+        ├── code-fix-task.md
+        ├── code-refactor-task.md
+        ├── doc-write-task.md
+        ├── research-task.md
+        └── test-task.md
+```
+
+---
+
+## Project Structure
+
+```
+ai-dev-workflow/
+├── skills/dev-workflow/             # Dev Workflow Skill (self-contained)
+│   ├── SKILL.md
+│   └── references/
+│       ├── workflow.md
+│       ├── task-types.md
+│       ├── service-transform.md
+│       └── templates/
+│
+├── src/                             # Requirements MCP Server source
+│   ├── index.ts                     # Entry & MCP Server definition
+│   ├── adapters/
+│   │   ├── base.ts                  # BaseAdapter abstract class
+│   │   ├── ones.ts                  # ONES adapter
+│   │   └── index.ts                 # Factory function createAdapter()
+│   ├── config/
+│   │   └── loader.ts                # Config loading & env resolution
+│   ├── tools/
+│   │   ├── get-requirement.ts       # get_requirement tool
+│   │   ├── search-requirements.ts   # search_requirements tool
+│   │   └── list-sources.ts          # list_sources tool
+│   ├── types/
+│   │   ├── auth.ts
+│   │   ├── config.ts
+│   │   └── requirement.ts
+│   └── utils/
+│       ├── http.ts
+│       └── map-status.ts
+│
+├── tests/                           # Tests
+├── .requirements-mcp.json.example   # MCP Server config template
+├── package.json
+├── tsconfig.json
+├── tsdown.config.ts
+└── vitest.config.ts
+```
+
+---
+
+## Tech Stack
+
+| Technology | Purpose |
+|------------|---------|
+| TypeScript | MCP Server language |
+| [@modelcontextprotocol/sdk](https://github.com/modelcontextprotocol/typescript-sdk) | MCP protocol SDK |
+| [Zod](https://zod.dev/) | Schema validation & type inference |
+| [tsdown](https://github.com/nicepkg/tsdown) | Build tool (ESM + CJS + dts) |
+| [Vitest](https://vitest.dev/) | Test framework |
+| [bumpp](https://github.com/antfu/bumpp) | Version management & publishing |
+| Node.js >= 20 | Runtime |
+
+---
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Dev mode
+pnpm dev
+
+# Build
+pnpm build
+
+# Run tests
+pnpm test
+
+# Type check
+pnpm lint
+```
+
+### Publishing
+
+This project uses [bumpp](https://github.com/antfu/bumpp) for version management:
+
+```bash
+# Interactive version bump, auto commit + tag + push
+pnpm release
+```
+
+---
+
+## License
+
+[MIT](LICENSE)