Software Planning Tool

🚀 Software Planning Tool

A server designed based on the Model Context Protocol (MCP) to facilitate software development planning through an interactive and structured process. This tool helps break down complex software projects into manageable tasks, track implementation progress, and maintain detailed development plans.

✨ Features

• Interactive Planning Meetings: Initiate and manage development planning meetings.
• To-Do List Management: Create, update, and track development tasks.
• Complexity Scoring: Assign complexity scores to tasks for better estimation.
• Code Examples: Include relevant code snippets in task descriptions.
• Implementation Plan: Save and manage detailed implementation plans.

📦 Installation

Install via Smithery

To automatically install the Software Planning Tool for Claude Desktop via Smithery, run the following command:

npx -y @smithery/cli install @NightTrek/Software-planning-mcp --client claude

Manual Installation

1. Clone the repository.
2. Install the dependencies:

pnpm install

3. Build the project:

pnpm run build

4. Add it to your MCP settings configuration file (usually located at ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json):

{
  "mcpServers": {
    "software-planning-tool": {
      "command": "node",
      "args": [
        "/path/to/software-planning-tool/build/index.js"
      ],
      "disabled": false,
      "autoApprove": []
    }
  }
}

🔧 Available Tools

start_planning

Start a new planning meeting with a specific goal.

{
  goal: string  // The goal of software development
}

add_todo

Add a new to-do item to the current plan.

{
  title: string,         // The title of the to-do item
  description: string,   // Detailed description
  complexity: number,    // Complexity: a number (0 - 10)
  codeExample?: string  // Optional: relevant code example
}

get_plan

Get the current implementation plan.

{
  plan: object  // The current implementation plan object
}

update_plan

Update the current implementation plan.

{
  updates: object  // The content to be updated
}

clear_plan

Clear the current implementation plan.

clear_plan

💻 Usage Examples

Basic Usage

Here are some examples of how to use the tool:

1. Start a planning meeting:

start_planning "Develop a new user interface"

2. Add a task:

add_todo {
  title: "Design the home page layout",
  description: "Create a new home page layout to ensure a smooth user experience.",
  complexity: 7
}

3. Get the current plan:

get_plan

4. Update the plan:

update_plan {
  timeline: { 
    phase1: "Requirement analysis completed",
    phase2: "Design phase in progress"
  }
}

5. Clear the plan:

clear_plan

Advanced Usage

The project's file structure is as follows:

Software Planning Tool
├── src/
│   ├── storage.ts      # Data persistence
│   ├── types.ts        # TypeScript type definitions
│   └── utils.ts        # Utility functions
├── build/              # Build output directory
└── package.json       # Project dependencies and configuration

Usage Instructions

1. Install the dependencies:

npm install

2. Start the tool:

npm start

3. Interact via the command line:

start_planning "Develop a new feature module"
add_todo {
  title: "Implement user authentication",
  description: "Add user authentication functionality to the system.",
  complexity: 8
}
get_plan
update_plan {
  status: "in_progress"
}
clear_plan

📚 Documentation

1. Introduction

The Software Planning Tool is an auxiliary tool designed for developers to help users efficiently formulate plans, manage tasks, and track progress during the software development process. With this tool, you can easily organize and manage all stages of a project to ensure its timely completion.

2. Installation and Configuration

2.1 Install Dependencies

First, you need to install the project's dependencies. Execute the following command in the project's root directory:

npm install

2.2 Start the Tool

After installation, you can start the tool using the following command:

npm start

3. Core Functions

3.1 Start a Planning Meeting

When starting a new planning phase, provide a goal or theme. For example:

start_planning "Develop a new user interface"

3.2 Add a Task

When adding a new task to the current implementation plan, ensure you provide the task title, description, and complexity score (ranging from 0 - 10). Here is an example:

add_todo {
  title: "Design the home page layout",
  description: "Create a new home page layout to ensure a smooth user experience.",
  complexity: 7
}

3.3 Get the Current Plan

You can view the current implementation plan at any time using the following command:

get_plan

3.4 Update the Plan

When the plan needs adjustment, provide the updated content. For example:

update_plan {
  timeline: { 
    phase1: "Requirement analysis completed",
    phase2: "Design phase in progress"
  }
}

3.5 Clear the Plan

If you need to reset the current implementation plan, execute the following command:

clear_plan

4. Project Structure

The project's file structure is as follows:

software-planning-tool/
├── src/
│   ├── storage.ts      # Data persistence logic
│   ├── types.ts        # TypeScript type definitions
│   └── utils.ts        # Collection of utility functions
├── build/              # Build output directory
└── package.json       # Project dependencies and configuration file

5. Usage Examples

Here are some typical usage scenarios:

1. Start a New Planning Phase:

start_planning "Optimize performance"

2. Add a Development Task:

add_todo {
  title: "Optimize database queries",
  description: "Reduce the response time of major queries.",
  complexity: 6
}

3. Update the Implementation Plan:

update_plan {
  status: "in_progress"
}

4. Get the Current Plan:

get_plan

5. Clear the Existing Plan:

clear_plan

6. Precautions

⚠️ Important Note

• Ensure that all dependencies are correctly installed.
• Before using it in a production environment, it is recommended to conduct thorough testing.
• If you encounter any issues, check the log files or refer to the documentation.

7. License

[Insert license information here]

8. Contact Information

If you need to contact the developers, please send an email to your.email@example.com.

📄 License

[Insert license information here]

📞 Contact

If you need to contact the developers, please send an email to your.email@example.com.

👨‍💻 Project Maintainers

• John Doe - john.doe@example.com
• Jane Smith - jane.smith@example.com

🙏 Thanks

Thanks to all contributors and users for their support, which has made this project a success.

This tool aims to simplify the planning phase of the software development process and help teams organize and execute projects more efficiently. We hope it will bring convenience to your next project!