soloflow

SoloFlow MCP Service Guidelines

This rule file provides guidelines for using the soloflow-mcp service to manage project documentation through Model Context Protocol (MCP).

Core Concepts

• Document Management: All project documents are stored in .soloflow/ directory
• MCP Operations: Use list, read, update, and init operations for document management
• MCP Prompts: Use structured prompts for software engineering best practices
• Absolute Paths: All operations require absolute project root paths for security
• Document Types: Predefined document types ensure consistency
• Project Initialization: Use init command to set up project configuration automatically
• Read Before Update: Always read existing content before updating documents

Supported Document Types

The following document types are supported, all stored in .soloflow/ directory:

• overview.md - Project overview and summary
• requirements.md - Functional and non-functional requirements
• system_architecture.md - Technical architecture design
• test_strategy.md - Testing strategy and plans
• ui_design.md - UI/UX design specifications
• tasks.md - Project task lists and progress
• deployment.md - Deployment and infrastructure docs
• notes.md - Project notes and observations

Available MCP Operations

1. Initialize Project Configuration

Initialize SoloFlow MCP configuration in the specified project root:

{
  "tool": "init",
  "args": {
    "projectRoot": "/Users/username/project"
  }
}

2. List Project Documents

Get all available documents in the project:

{
  "tool": "list",
  "args": {
    "projectRoot": "/Users/username/project"
  }
}

3. Read Document Content

Read a specific document type:

{
  "tool": "read",
  "args": {
    "projectRoot": "/Users/username/project",
    "type": "requirements"
  }
}

4. Update Document Content

Create or update a document: