Skip to main content
Glama
README.md
# wassden

[![CI](https://github.com/tokusumi/wassden-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/tokusumi/wassden-mcp/actions/workflows/ci.yml)
[![Python](https://img.shields.io/badge/python-3.12%2B-blue)](https://www.python.org/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![MCP](https://img.shields.io/badge/MCP-Compatible-green)](https://modelcontextprotocol.io/)

**Spec-Driven Development MCP server that transforms any LLM into a systematic development agent**

> πŸš€ Generate requirements β†’ design β†’ tasks β†’ code with 100% traceability and validation

## ⚑ Quick Start (MCP)

```bash
# Add to Claude Code
claude mcp add wassden -- uvx --from git+https://github.com/tokusumi/wassden-mcp wassden start-mcp-server --transport stdio

# Test it
uvx --from git+https://github.com/tokusumi/wassden-mcp wassden prompt-requirements --userInput "Create a TODO app"
```

## 🎯 What It Does

- βœ… **Requirements β†’ Design β†’ Tasks β†’ Code** - Complete SDD workflow with structured prompts
- πŸ”’ **100% READ-ONLY** - No file modification risk, only analysis and prompt generation
- 🌍 **Auto Language Detection** - Seamless Japanese/English support
- ⚑ **Ultra-fast Performance** - <0.01ms response time with 405+ tests passing
- πŸ“Š **100% Traceability** - Complete REQ↔DESIGN↔TASK mapping enforcement

## πŸ“¦ Installation

### Prerequisites
- [uv package manager](https://docs.astral.sh/uv/getting-started/installation/) (`pip install uv`)
- MCP-compatible client (Claude Code, Cursor, GitHub Copilot, etc.)

### Claude Code
```bash
claude mcp add wassden -- uvx --from git+https://github.com/tokusumi/wassden-mcp wassden start-mcp-server --transport stdio
```

### Cursor, GitHub Copilot, Other MCP Clients
Edit your MCP settings file:
```json
{
  "mcpServers": {
    "wassden": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/tokusumi/wassden-mcp",
        "wassden",
        "start-mcp-server",
        "--transport",
        "stdio"
      ]
    }
  }
}
```

> πŸ“š For detailed setup and development installation, see [docs/development.md](docs/development.md)

## πŸš€ Basic Usage

### 1. Analyze & Generate Requirements

```bash
# Analyze project description and generate requirements prompt
uvx --from git+https://github.com/tokusumi/wassden-mcp wassden prompt-requirements \
  --userInput "Create a task management API with authentication"
```

### 2. Validate Generated Specs

```bash
# Validate specifications with auto language detection
uvx --from git+https://github.com/tokusumi/wassden-mcp wassden validate-requirements specs/my-feature/requirements.md
uvx --from git+https://github.com/tokusumi/wassden-mcp wassden validate-design specs/my-feature/design.md  
uvx --from git+https://github.com/tokusumi/wassden-mcp wassden validate-tasks specs/my-feature/tasks.md
```

### 3. Get Traceability Matrix

```bash
# Generate complete dependency mapping
uvx --from git+https://github.com/tokusumi/wassden-mcp wassden get-traceability
```

## πŸ› οΈ Core Tools

### Requirements Generation
- **`prompt-requirements`** - Analyzes input for completeness and generates EARS requirements prompt
  - Default: Checks completeness, asks questions if incomplete, generates prompt if complete
  - `--force`: Skip completeness verification and generate requirements prompt

### Design & Planning  
- **`prompt-design`** - Generates architectural design prompt from requirements
- **`prompt-tasks`** - Creates WBS task breakdown prompt from design

### Validation Suite
- **`validate-requirements`** - Ensures EARS format and completeness
- **`validate-design`** - Checks architectural consistency
- **`validate-tasks`** - Verifies task dependencies and coverage

### Traceability & Analysis
- **`get-traceability`** - Complete REQ↔DESIGN↔TASK dependency mapping
- **`analyze-changes`** - Impact analysis for specification changes
- **`generate-review-prompt`** - Task-specific implementation review

> πŸ“š See [full tool documentation](docs/tools.md) for detailed usage and examples

## πŸ“Š Performance

- **Response Time**: <0.01ms average (ultra-fast analysis)
- **Test Coverage**: 405+ tests with 100% passing
- **Memory Efficient**: <50MB growth per 1000 operations
- **Concurrent Support**: Handles 20+ parallel tool calls efficiently

> πŸ§ͺ Run benchmarks: `python benchmarks/run_all.py`

## πŸ§ͺ Development Mode Features (Experimental)

**⚠️ NOTE: Experimental features for internal validation and benchmarking. Requires dev installation.**

The experiment framework provides validation and benchmarking capabilities for the wassden toolkit itself. These features are only available in development mode:

```bash
# Install with dev dependencies
git clone https://github.com/tokusumi/wassden-mcp
cd wassden-mcp
uv sync  # Installs all dependencies including dev extras

# Run experiments (dev mode only)
uv run wassden experiment run ears        # EARS pattern validation
uv run wassden experiment run performance # Performance benchmarking  
uv run wassden experiment run language    # Language detection testing
```

### Key Capabilities

- **Statistical Analysis**: Mean, variance, confidence intervals (REQ-04)
- **Experiment Management**: Save/load/compare configurations (REQ-05, REQ-06)
- **Comparative Analysis**: Statistical significance testing (REQ-07)
- **Resource Constraints**: 10-minute timeout, 100MB memory limit (NFR-01, NFR-02)

> πŸ“š See [Experiment Framework Documentation](docs/experiment-framework.md) for detailed usage

## 🎯 Use Cases

- **Development Teams**: Systematic requirements gathering and project planning
- **AI Agents**: Structured prompts for complex development workflows
- **Technical Writers**: Automated documentation validation and traceability
- **Quality Assurance**: Built-in validation with actionable feedback

## πŸ“š Documentation

- **[Getting Started](docs/quickstart.md)** - Installation and first steps
- **[Tool Reference](docs/tools.md)** - Complete tool documentation
- **[Spec Format Guide](docs/spec-format.md)** - Requirements, design, and tasks format
- **[Validation Rules](docs/validation/)** - EARS format and traceability requirements
- **[Validation System](docs/validation.md)** - Comprehensive validation with AST-based analysis
- **[Development](docs/development.md)** - Development setup and contributing
- **[Experiment Framework](docs/experiment-framework.md)** - Experimental validation features (dev only)
- **[Examples](docs/ja/spec-example/)** - Sample specifications (Japanese/English)

## 🀝 Contributing

Contributions are welcome! See [docs/development.md](docs/development.md) for development setup.

```bash
make check  # Run all quality checks before committing
```

## πŸ“„ License

MIT License - see [LICENSE](LICENSE) file for details.

---

**Built with ❀️ for the AI-driven development community**