export declare const SOLOFLOW_MDC_CONTENT = "---\nalwaysApply: true\n---\n\n# SoloFlow MCP Service Guidelines\n\nThis rule file provides guidelines for using the `soloflow-mcp` service to manage project documentation through Model Context Protocol (MCP).\n\n## **Core Concepts**\n\n- **Document Management**: All project documents are stored in `.soloflow/` directory\n- **MCP Operations**: Use `list`, `read`, `update`, and `init` operations for document management\n- **MCP Prompts**: Use structured prompts for software engineering best practices\n- **Absolute Paths**: All operations require absolute project root paths for security\n- **Document Types**: Predefined document types ensure consistency\n- **Project Initialization**: Use `init` command to set up project configuration automatically\n- **Read Before Update**: Always read existing content before updating documents\n\n## **Supported Document Types**\n\nThe following document types are supported, all stored in `.soloflow/` directory:\n\n- `overview.md` - Project overview and summary\n- `requirements.md` - Functional and non-functional requirements\n- `system_architecture.md` - Technical architecture design\n- `test_strategy.md` - Testing strategy and plans\n- `ui_design.md` - UI/UX design specifications\n- `tasks.md` - Project task lists and progress\n- `deployment.md` - Deployment and infrastructure docs\n- `notes.md` - Project notes and observations\n\n## **Available MCP Operations**\n\n### **1. Initialize Project Configuration**\n\nInitialize SoloFlow MCP configuration in the specified project root:\n\n```json\n{\n  \"tool\": \"init\",\n  \"args\": {\n    \"projectRoot\": \"/Users/username/project\"\n  }\n}\n```\n\n### **2. List Project Documents**\n\nGet all available documents in the project:\n\n```json\n{\n  \"tool\": \"list\",\n  \"args\": {\n    \"projectRoot\": \"/Users/username/project\"\n  }\n}\n```\n\n### **3. Read Document Content**\n\nRead a specific document type:\n\n```json\n{\n  \"tool\": \"read\",\n  \"args\": {\n    \"projectRoot\": \"/Users/username/project\",\n    \"type\": \"requirements\"\n  }\n}\n```\n\n### **4. Update Document Content**\n\nCreate or update a document:\n\n```json\n{\n  \"tool\": \"update\",\n  \"args\": {\n    \"projectRoot\": \"/Users/username/project\",\n    \"type\": \"requirements\",\n    \"content\": \"# Project Requirements\\n\\n## Functional Requirements\\n1. User management\\n2. Data storage\\n3. Report generation\"\n  }\n}\n```\n\n## **Available MCP Prompts**\n\n### **1. Project Initialization Prompt**\n\nInitialize project documentation structure:\n\n```json\n{\n  \"prompt\": \"init-project\",\n  \"args\": {\n    \"projectName\": \"My Project\"\n  }\n}\n```\n\n### **2. Create Document Template Prompt**\n\nCreate a standard template for a specific document type:\n\n```json\n{\n  \"prompt\": \"create-doc-template\",\n  \"args\": {\n    \"docType\": \"requirements\",\n    \"projectName\": \"My Project\"\n  }\n}\n```\n\n### **3. Add Task Prompt**\n\nAdd a new task to the project task list:\n\n```json\n{\n  \"prompt\": \"add-task\",\n  \"args\": {\n    \"taskTitle\": \"Implement user authentication\",\n    \"priority\": \"high\",\n    \"category\": \"backend\",\n    \"estimatedTime\": \"2d\"\n  }\n}\n```\n\n### **4. Check Project Status Prompt**\n\nAnalyze project documentation completeness and task progress:\n\n```json\n{\n  \"prompt\": \"check-project-status\"\n}\n```\n\n### **5. Code Review Checklist Prompt**\n\nGet a standard code review checklist:\n\n```json\n{\n  \"prompt\": \"code-review-checklist\",\n  \"args\": {\n    \"codeLanguage\": \"TypeScript\"\n  }\n}\n```\n\n### **6. Deployment Checklist Prompt**\n\nGet a deployment preparation checklist:\n\n```json\n{\n  \"prompt\": \"deployment-checklist\",\n  \"args\": {\n    \"environment\": \"production\"\n  }\n}\n```\n\n## **Development Workflow & Documentation Maintenance**\n\n### **Critical Rule: Read Before Update**\n\n**ALWAYS read existing document content before updating:**\n\n1. **Read First**: Use `read` operation to get current document content\n2. **Analyze Content**: Understand existing structure and content\n3. **Preserve Continuity**: Maintain document consistency and history\n4. **Update Carefully**: Apply changes while preserving existing information\n5. **Verify Completeness**: Ensure all changes are properly documented\n\n### **Document Update Process**\n\n1. **Read Existing Content**: Always use `read` operation first\n2. **Analyze Current State**: Understand existing structure and content\n3. **Plan Updates**: Determine what needs to be added or modified\n4. **Preserve History**: Keep existing content and add update history\n5. **Cross-Reference**: Ensure consistency across all related documents\n6. **Verify Changes**: Confirm all updates are complete and accurate\n\n### **Fallback Document Access**\n\n- **When MCP Service Unavailable**: If `soloflow-mcp` service cannot be called, directly read/write files in `.soloflow/` directory\n- **Direct File Operations**: Use standard file system operations to access `.soloflow/*.md` files\n- **Example**: readFile `.soloflow/requirements.md`, writeFile `.soloflow/requirements.md`\n\n### **Task Execution Standards**\n\n- **Reference Current Documentation**: Always check `.soloflow/` directory contents before starting any task\n- **Completion Criteria**: Task is only complete when:\n  - All tests pass (`npm test` or equivalent)\n  - Code changes are tested and verified\n  - Documentation is updated\n- **Task Documentation**: After completing any task, update [tasks.md](mdc:.soloflow/tasks.md) with:\n  - Completed task status\n  - New tasks discovered during implementation\n  - Updated timeline if needed\n\n### **Documentation Update Triggers**\n\n**Always update relevant documentation when:**\n\n- **Requirements Change**: User requests new features or modifies existing requirements\n- **Architecture Changes**: System design or technical architecture is modified\n- **Implementation Discoveries**: Important findings during development that affect design\n- **API Changes**: MCP operations or interfaces are modified\n- **Security Updates**: Security-related changes or vulnerabilities discovered\n- **Prompt Usage**: When using prompts to generate or modify documents\n\n### **Documentation Update Process**\n\n1. **Identify Affected Documents**: Determine which `.soloflow/` documents need updates\n2. **Read Existing Content**: Always read current content before making changes\n3. **Update Content**: Modify relevant documents with new information\n4. **Cross-Reference**: Ensure consistency across all related documents\n5. **Version Control**: Add update history entries to modified documents\n6. **Verify Completeness**: Ensure all changes are properly documented\n\n## **Usage Scenarios**\n\n### **Scenario 1: Initialize New Project**\n\nWhen starting a new project and need to set up SoloFlow MCP:\n\n```json\n{\n  \"tool\": \"init\",\n  \"args\": {\n    \"projectRoot\": \"/Users/username/project\"\n  }\n}\n```\n\n### **Scenario 2: Check Project Documentation**\n\nWhen you need to understand what documents exist in the project:\n\n```json\n{\n  \"tool\": \"list\",\n  \"args\": {\n    \"projectRoot\": \"/Users/username/project\"\n  }\n}\n```\n\n### **Scenario 3: Read Requirements Document**\n\nWhen you need to review project requirements:\n\n```json\n{\n  \"tool\": \"read\",\n  \"args\": {\n    \"projectRoot\": \"/Users/username/project\",\n    \"type\": \"requirements\"\n  }\n}\n```\n\n### **Scenario 4: Update Task List (with Read First)**\n\nWhen you need to update project tasks:\n\n1. **First, read existing content:**\n\n    ```json\n    {\n      \"tool\": \"read\",\n      \"args\": {\n        \"projectRoot\": \"/Users/username/project\",\n        \"type\": \"tasks\"\n      }\n    }\n    ```\n\n2. **Then, update with new content:**\n\n    ```json\n    {\n      \"tool\": \"update\",\n      \"args\": {\n        \"projectRoot\": \"/Users/username/project\",\n        \"type\": \"tasks\",\n        \"content\": \"# Project Tasks\\n\\n## To Do\\n- [ ] Implement user authentication\\n- [ ] Add data validation\\n\\n## Completed\\n- [x] Project initialization\\n- [x] Basic architecture setup\"\n      }\n    }\n    ```\n\n### **Scenario 5: Create System Architecture Document**\n\nWhen you need to document system architecture:\n\n```json\n{\n  \"tool\": \"update\",\n  \"args\": {\n    \"projectRoot\": \"/Users/username/project\",\n    \"type\": \"system_architecture\",\n    \"content\": \"# System Architecture\\n\\n## Overall Architecture\\n\\n```mermaid\\ngraph TD\\n    A[Frontend] --> B[API]\\n    B --> C[Database]\\n```\\n\\n## Tech Stack\\n- Frontend: React + TypeScript\\n- Backend: Node.js + Express\\n- Database: PostgreSQL\"\n  }\n}\n```\n\n### **Scenario 6: Use Prompts for Software Engineering**\n\nWhen you need structured guidance for software engineering practices:\n\n1. **Initialize project with prompts:**\n\n    ```json\n    {\n      \"prompt\": \"init-project\",\n      \"args\": {\n        \"projectName\": \"My Web Application\"\n      }\n    }\n    ```\n\n2. **Create document templates:**\n\n    ```json\n    {\n      \"prompt\": \"create-doc-template\",\n      \"args\": {\n        \"docType\": \"requirements\"\n      }\n    }\n    ```\n\n3. **Add tasks with prompts:**\n\n    ```json\n    {\n      \"prompt\": \"add-task\",\n      \"args\": {\n        \"taskTitle\": \"Implement user authentication\",\n        \"priority\": \"high\",\n        \"category\": \"backend\"\n      }\n    }\n    ```\n\n4. **Check project status:**\n\n    ```json\n    {\n      \"prompt\": \"check-project-status\"\n    }\n    ```\n\n5. **Get code review checklist:**\n\n    ```json\n    {\n      \"prompt\": \"code-review-checklist\",\n      \"args\": {\n        \"codeLanguage\": \"TypeScript\"\n      }\n    }\n    ```\n\n6. **Get deployment checklist:**\n\n    ```json\n    {\n      \"prompt\": \"deployment-checklist\",\n      \"args\": {\n        \"environment\": \"production\"\n      }\n    }\n    ```\n\n## **Security Considerations**\n\n- **Absolute Paths Required**: `projectRoot` must be an absolute path\n- **Access Control**: Only `${projectRoot}/.soloflow/*.md` files are accessible\n- **Type Validation**: `type` parameter must be a predefined document type\n- **No Concurrent Writes**: Concurrent write operations are not supported\n- **Initialization Safety**: `init` command only creates configuration files, never overwrites existing documents\n- **Read Before Update**: Always read existing content to preserve document continuity\n\n## **Best Practices**\n\n### **Project Initialization Workflow**\n\n1. **Run Init Command**: Use `init` to set up project configuration\n2. **Check Existing Documents**: Use `list` operation to see current state\n3. **Create Core Documents**: Use `update` to create essential documents\n4. **Use Prompts**: Leverage prompts for structured guidance\n5. **Maintain Documentation**: Regularly update documents as project evolves\n\n### **Document Naming Convention**\n\n- All documents use Markdown format\n- Filenames are fixed as `<type>.md`\n- Support for Mermaid diagrams, code blocks, and rich text content\n\n### **Document Structure Template**\n\nEach document should include:\n\n```markdown\n# Document Title\n\n## Overview\nBrief description of the document's purpose and content.\n\n## Detailed Content\nSpecific document content...\n\n## Update History\n- 2025-07-24: Initial version\n- 2025-07-25: Added new features\n```\n\n### **Workflow Process**\n\n1. **Initialize Project**: Use `init` operation to set up configuration\n2. **Check Existing Documents**: Use `list` operation\n3. **Read Documents**: Use `read` operation to get content\n4. **Update Documents**: Use `update` operation to modify content\n5. **Use Prompts**: Leverage prompts for structured guidance\n\n### **Prompt Usage Guidelines**\n\n1. **Choose Appropriate Prompt**: Select the right prompt for your task\n2. **Provide Required Parameters**: Fill in necessary parameters\n3. **Review Generated Content**: Always review prompt-generated content\n4. **Customize as Needed**: Modify generated content to fit your specific needs\n5. **Update Documentation**: Always update relevant documentation after using prompts\n\n## **Quick Start Guide**\n\n### **Step 1: Initialize Project**\n\n```json\n{\n  \"tool\": \"init\",\n  \"args\": {\n    \"projectRoot\": \"/Users/username/project\"\n  }\n}\n```\n\n### **Step 2: Check Project Documents**\n\n```json\n{\n  \"tool\": \"list\",\n  \"args\": {\n    \"projectRoot\": \"/Users/username/project\"\n  }\n}\n```\n\n### **Step 3: Create Requirements Document**\n\n```json\n{\n  \"tool\": \"update\",\n  \"args\": {\n    \"projectRoot\": \"/Users/username/project\",\n    \"type\": \"requirements\",\n    \"content\": \"# Project Requirements\\n\\n## Functional Requirements\\n1. User management\\n2. Data storage\\n3. Report generation\\n\\n## Non-functional Requirements\\n- Performance: Response time < 2 seconds\\n- Availability: 99.9%\\n- Security: Data encryption\"\n  }\n}\n```\n\n### **Step 4: Create Task List**\n\n```json\n{\n  \"tool\": \"update\",\n  \"args\": {\n    \"projectRoot\": \"/Users/username/project\",\n    \"type\": \"tasks\",\n    \"content\": \"# Project Tasks\\n\\n## This Week\\n- [ ] Complete user authentication module\\n- [ ] Implement data validation\\n- [ ] Write unit tests\\n\\n## Next Week\\n- [ ] Integrate third-party services\\n- [ ] Performance optimization\\n- [ ] Documentation completion\"\n  }\n}\n```\n\n### **Step 5: Use Prompts for Guidance**\n\n```json\n{\n  \"prompt\": \"check-project-status\"\n}\n```\n\n## **Troubleshooting**\n\n### **Common Errors**\n\n1. **Path Error**: Ensure `projectRoot` is an absolute path\n2. **Type Error**: Ensure `type` is a predefined document type\n3. **File Not Found**: Use `update` operation to create new documents\n4. **Init Error**: Ensure you have write permissions in the project directory\n5. **Prompt Error**: Ensure prompt parameters are correctly formatted\n\n### **Debugging Tips**\n\n- Use `init` operation to set up project configuration\n- Use `list` operation to check project structure\n- Confirm `.soloflow/` directory exists after initialization\n- Verify document type is correct\n- Always read existing content before updating\n- Use prompts for structured guidance\n\n## **Related Documentation**\n\n- [requirements.md](mdc:.soloflow/requirements.md) - Detailed functional requirements\n- [system_architecture.md](mdc:.soloflow/system_architecture.md) - Technical architecture design\n- [test_strategy.md](mdc:.soloflow/test_strategy.md) - Testing plans and strategies\n- [tasks.md](mdc:.soloflow/tasks.md) - Project task lists and progress\n\n## **Update History**\n\n- 2025-07-30: Added MCP Prompts support and Read Before Update rule\n- 2025-07-24: Initial version with basic MCP operations\n";
//# sourceMappingURL=soloflow-content.d.ts.map